Payment facilitator (API)
This page outlines the specification for payment facilitator fields.
Before getting started, you will need to contact our Support Team and request that the payment facilitator functionality is enabled on your account. Then you can update your requests using the following specification.
There are two methods that can be used to include payment facilitator fields in requests submitted to the acquiring bank:
- Method 1: By assigning default values on your account:
Using this method, the payment facilitator fields are automatically included in transactions processed on your account, with no additional configuration required. To configure your account to use this method, contact our Support Team, requesting that the payment facilitator functionality is enabled on your account, along with your preferred default values.
- Method 2: By manually including payment facilitator fields in your requests:
Using this method allows you to specify different values on a request-by-request basis. To configure your account to use this method, contact our Support Team and request that the payment facilitator functionality is enabled on your account. Then you can update your requests using the following specification.
Submitting payment facilitator fields in a request
The following is an example of a request where payment facilitator fields are included:
You will need to update the payload submitted within your JWT to include an additional fields, as shown below. Submitting the payment facilitator fields in this way will always override any values stored on your account or inherited from a parent.
|chargedescription||Alphanumeric including spaces and special characters||25||The charge description is a field that we provide to the acquiring bank during a transaction. It is a basic description of the transaction that is shown on the customer’s bank statement.|
|facilitatorid||Numeric||11||The payment facilitator id assigned by Mastercard at time of registration.|
|facilitatorname||Alphanumeric including spaces and special characters||3, 7 or 12 ONLY||The payment facilitator name agreed with Mastercard.|
|independentsalesorgid||Numeric||11||The ISO (Independent Sales Organisation) id assigned by Mastercard at time of registration.|
|submerchantid||Alphanumeric including spaces and special characters||15||Value assigned by the payment facilitator when involved in the transaction.|
- chargedescription, facilitatorid, facilitatorname, independentsalesorgid, submerchantid.
- chargedescription, facilitatorid, facilitatorname, submerchantid.
- chargedescription, facilitatorname, independentsalesorgid
An invalid combination of facilitator fields sent in the request will result in an invalid field error (30000).
Supported request types
The payment facilitator fields can be submitted in the following requests:
Inheriting from parent requests
If you do not submit the payment facilitator fields in a request, and a parent transaction reference is specified, the payment facilitator fields are inherited from said parent, unless the parent request type is AUTH or REFUND.