Payouts to Australia

Payout parameters

Name	Mandatory	Type	Description
payment_method/payout_details	+	object	Payout data
type	+	string	Value: bank_account
bank_account	+	object	Bank account
system_type	+	string	Value: global
global	+	object	Bank account details
bank_account_number	+	string	Bank account number for the payout
bsb_number	+	string	Recipient's bank’s BSB code (6 characters): XX–Y–ZZZ (XX = financial institution, Y = state, ZZZ = bank office location)
description	+	string	Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
participant_details	+	object	Information on the payout participants
recipient	+	object	Recipient details
address_line	+	string	Recipient's street address (up to 256 characters)
city	+	string	Recipient's city (up to 64 characters)
postal_code	+	string	Recipient's postal code (up to 64 characters)
state	+	string	Recipient's state (up to 64 characters)
bank_name	+	string	Important: the bank name must be chosen from the Supported Local Banks, otherwise, the payout will not be processed
currency	+	string	Recipient's currency in ISO 4217 format. Case insensitive
country_iso3	+	string	Recipient's country code (ISO-3166-1 alpha-3)
first_name	+	string	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_name	+	string	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
sender	+	object	Sender details
address_line	+	string	Sender's street address (up to 256 characters)
company_name	+	string	Sender company name (up to 100 characters, cannot contain digits only)
registration_number	+	string	Sender company registration number
country_iso3	+	string	Sender’s country code (ISO-3166-1 alpha-3)
code	+	string	Sender company registration number
city	+	string	Sender's city (up to 64 characters)
state	-	string	Sender's state (up to 64 characters)
amount_details	+	object	Payout amount details
amount	+	int	Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000
currency	+	string	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

Country	Currency	Bank
Australia	AUD	All Banks / Payment System: Default