Endpoint - Payment Tags
This call is expected to return an array of payment methods friendly names and their tags to generate a pre-populated list in the config payment mapping screen.
Request
Post
PaymentTagsRequest
PaymentTagsRequest
Field Name | Type | Description |
---|---|---|
AuthorizationToken | String | Authorization Token from the customers integration. |
Sample
{
"AuthorizationToken": "0dfdbaf3e4d5434f825e774e31bcc148"
}
Response
PaymentTagsResponse
PaymentTagsResponse
Field Name | Type | Description |
---|---|---|
Error | String | If there was an error with the request. |
PaymentTags | PaymentTags[] | Array of payment tags. See PaymentTags table. |
PaymentTags
PaymentTags
Field Name | Type | Description |
---|---|---|
Tag | String | The payment tag that is supplied on the order. |
FriendlyName | String | Friendly name of the payment tag. |
Site | String | Site of the payment tag, this is usually used when the channel has one set of credentials however has multiple sites for example UK, DE, US and so on. Leave blank if this is not applicable. |
Sample
{
"Error": null,
"PaymentTags": [
{
"Tag": "paypal_verified",
"FriendlyName": "PayPal",
"Site": ""
},
{
"Tag": "mastercard",
"FriendlyName": "Credit Card - Master Card",
"Site": ""
},
{
"Tag": "credit_unknown",
"FriendlyName": "Credit Card - Unknown",
"Site": ""
},
{
"Tag": "bank",
"FriendlyName": "Bank payments",
"Site": ""
}
]
}
{
"Error": "Invalid authorization token",
"ShippingTags": []
}
Updated over 1 year ago