Payment Aggregators
Limited Acquirer Support For Payment AggregatorsProcessing 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 | required |
aggregator_name | String (max 38 characters) Note:aggregator_name + name must not exceed 37 characters | The aggregator name assigned to you by your acquirer | required |
name | String Note:aggregator_name + name must not exceed 37 characters | The business name of the sub merchant | required |
address | String | The street address of the sub merchant | required |
city | String | The city of the sub merchant | required |
state | String | The state of the sub merchant | required |
postcode | String | The postcode of the sub merchant | required |
country_code | String | The country code of the sub merchant in 2-letter ISO 3166-2 | Optional |
phone | String | The merchant phone number. | Either one of phone or email are required |
String
| The merchant email address (for customers to contact if required) | Either one of phone or email are required | |
mcc | String | The sub-merchant's Merchant Category Code. | required |
{
"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 10 days ago