Skip to main content

Payouts to Australia

Payout parameters

NameTypeMandatoryDescription
payment_methodPaymentMethod+Payout data
 typestring+Value: bank_account
 bank_accountBankAccountPaymentMethod+Bank account
  system_typestring+Value: global
  globalBankAccountGlobal+Bank account details
   bank_account_numberstring+Bank account number for the payout
   bsb_numberstring+Recipient's bank’s BSB code (6 characters): XX–Y–ZZZ (XX = financial institution, Y = state, ZZZ = bank office location)
   descriptionstring+Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
participant_detailsParticipantDetails+Information on payout participants
 recipientParticipant+Recipient details
  address_linestring+Recipient's street address (up to 256 characters)
  citystring+Recipient's city (up to 64 characters)
  postal_codestring+Recipient's postal code (up to 64 characters)
  statestring+Recipient's state (up to 64 characters)
  bank_namestring+Important: the bank name must be chosen from the Supported Local Banks, otherwise, the payout will not be processed
  currencystring+Recipient's currency in ISO 4217 format. Case insensitive
  country_iso3string+Recipient's country code (ISO-3166-1 alpha-3)
  first_namestring+Recipient's first name (up to 64 characters, cannot contain digits only). Important: if the name is passed incorrectly, the recipient bank may not accept the payout
 last_namestring+Recipient's last name (up to 80 characters, cannot contain digits only). Important: if the name is passed incorrectly, the recipient bank may not accept the payout
 senderParticipant+Sender details
  address_linestring+Sender's street address (up to 256 characters)
  company_namestring+Sender company name (up to 100 characters, cannot contain digits only)
  registration_numberstring+Sender company registration number
  country_iso3string+Sender’s country code (ISO-3166-1 alpha-3)
  codestring+Sender company registration number
  citystring+Sender's city (up to 64 characters)
  statestring-Sender's state (up to 64 characters)
amount_detailsAmountDetails+Payout amount details
 amountint+Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
 currencystring+ISO 4217 currency code. Case insensitive

Example

curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d'{
"session_id": "ps_1053680",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "global",
"global": {
"bank_account_number": "NUMBER_VALUE",
"bsb_number": "XX–Y–ZZZ",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"address_line": "Gilbert Street",
"city": "Flowerdale",
"postal_code": "7325",
"state": "Tasmania",
"bank_name": "All Banks / Payment System: Default",
"currency": "AUD",
"country_iso3": "AUS",
"first_name": "John",
"last_name": "Johnson"
}
},
"sender": {
"address_line": "Wall Street",
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "USA",
"city": "New York",
"code": "1234567890"
}
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}

List of supported banks

CountryCurrencyBank
AustraliaAUDAll Banks / Payment System: Default