API Reference

FeeAPI Parameter Definitions

post
https://uat.txshield.payshield.ai/soap/feeapi.php
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Site id (unique identifier for the web site)

string
required

Site RCODE

string
required

Country of the user - will provide the list of payments available for that country

boolean

This will add the processing fees on top of the amount.

cart
array of strings
required
Defaults to 'name' => 'item name','quantity' => 'item quantity','amount_unit' => 'item amount per unit','item_no' => 'item number','item_desc' => 'item description'

Information about the purchase items. This is only compulsory for feeapi, do not sent the cart to rawfeeapi.

cart*
summary
array of strings
required
Defaults to 'currency_code' => '3 letter currency code the transaction will be processed in.','fxrate_posted' => 'rate to be used to convert','amount_shipping' => 'amount shipping','amount_coupon' => 'coupon amount','amount_tax' => 'tax amount','amount_purchase' => 'total purchase amount'

Contains a summary of cart contents

summary*
string
required

Total amount of purchase

string
required

Shipping amount

string
required

tax amount

string
required

Coupon amount

string
required

Rate used for conversion of cart currency to gw currency. Enter Buy cart currency Sell Gw currency

string

3 digit currency code of the cart currency

items
array of strings
required

Contains the cart items

items*
(numerical index)
array of strings
required

Contains information about one item in the cart (Repeat until all cart items are listed)

(numerical index)*
string
required

Category, can be used freely

int32
required

Quantity of the item

string
required

Unit price amount (without commas and only 2 decimals places)

string
required

Article number

string
required

Item description

Responses

Updated almost 5 years ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 5 years ago