Payment Aggregators
Limited Acquirer Support For Payment Aggregators
Processing transactions as a Payment Aggregator is not supported by all Australian acquirers. If these methods are used where support is not yet available the transactions may be declined or return errors. Contact the Fat Zebra support team for more information.
The Payment Aggregator fields allow merchants who act as a Payment Aggregator to specify sub-merchant details required by their acquirers. This is currently only supported for a handful of banks, and must be enabled before use by contacting the Fat Zebra support team.
Payment Aggregator fields are specified in the field sub_merchant of type Hash. They can be specified on authorisation, purchase, and refund transactions.
| Field | Type | Description | Required |
|---|---|---|---|
| id | String (max 20 characters) | The sub merchant's id as specified by your acquirer | This field is mandatory for Westpac merchants and for Amex Payment Facilitator/Aggregator transactions |
| aggregator_name | String (max 38 characters) Note: aggregator_name + name must not exceed 37 characters | The aggregator name assigned to you by your acquirer | mandatory for Westpac merchants this is a 3 character string |
| name | String (max 38 characters) Note: aggregator_name + name must not exceed 37 characters | The business name of the sub merchant | Optional |
| address | String (max 38 characters) | The street address of the sub merchant | mandatory for Westpac merchants |
| city | String (max 21 characters) | The city of the sub merchant | Optional |
| state | String (max 3 characters) | The state of the sub merchant | Optional |
| postcode | String (max 15 characters) | The postcode of the sub merchant | mandatory for Westpac merchants |
| country_code | String (max 2 characters) | The country code of the sub merchant in 2-letter ISO 3166-2 e.g. AU | Optional |
| phone | String (max 20 digits only) | The merchant phone number. e.g. 0404444444 | Mandatory for Payment Facilitators / Aggregator Amex transactions |
| String *(max 40 characters) | The merchant email address (for customers to contact if required) e.g [email protected] | Mandatory for Payment Facilitators / Aggregator Amex transactions | |
| mcc | String (exactly 4 digits) | The sub-merchant's Merchant Category Code. e.g. 5942 | Mandatory for Payment Facilitators / Aggregator Amex transactions |
{
"extra": {
"sub_merchant": {
"id": "ABC",
"aggregator_name": "FZ",
"name": "ABC Pty Ltd",
"address": "58 Kippax Street",
"city": "Surry Hills",
"state": "NSW",
"postcode": "2010",
"country_code": "AU",
"email": "[email protected]",
"phone": "0290371840",
"mcc": "5942"
}
}
}
Updated 6 days ago