Documentation
Beneficiaries
Australia Beneficiary

Australia Beneficiary

You can make payments to any Australian bank account. Funds will typically be settled in the beneficiary’s account within 24 hours. Please note that transactions are not processed on weekends or public holidays, which may cause delays in settlement.

Here is a sample request to add an Australian beneficiary:

cURL
curl --location '{{sandboxURL}}/beneficiaries' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{APIKEY}}' \
--data '{
    "reference": "<samplereference>",
    "callbackUrl": "https://webhook.site/38a9e65e-3388-4399-89d4-3ceafa8173dd",
    "customerEmail": "roy@email.com",
    "country": "AU",
    "currency": "AUD",
    "destination": {
        "type": "BANK",
        "BSBNumber": "063000",
        "accountName": "Nimali Daniels",
        "accountNumber": "47270000",
        "remittancePurpose": "FAMILY_SUPPORT",
        "beneficiary": {
            "type": "INDIVIDUAL",
            "country": "AU",
            "state": "New South Wales",
            "city": "Sydney",
            "address": "123 Example Street",
            "postCode": "2000"
        },
        "sender": {
            "type": "BUSINESS",
            "accountName": "Ray Jon",
            "country": "AU",
            "city": "Melbourne",
            "address": "456 Another St",
            "postCode": "2000",
            "businessRegistrationNumber": "1234567890"
        }
    }
}'

The parameters for adding beneficiary Australian bank accounts are

ParameterDescriptionRequired
typeThe type of destination. Must be "BANK".
BSBNumberAustralian bank's BSB number.
accountNameName of the beneficiary's account.
A space separated first and last name must be provided for individual beneficiaries e.g John Doe
accountNumberThe Australian bank account number
remittancePurposePurpose of the remittance.
See accepted remittance purposes here (opens in a new tab)
senderSender information. Expanded based on sender[type].
beneficiaryBeneficiary information.

Sender Parameters

ParameterDescriptionRequired
sender[type]Type of sender. It must be "BUSINESS".
sender[accountName]Name of the sender's account.
A space separated first and last name must be provided for individual senders e.g John Doe
sender[country, city, address]Sender's address details: country, city, and address.
sender[postCode]Sender's postcode.
sender[businessRegistrationNumber]Business registration number.

Beneficiary Parameters

ParameterDescriptionRequired
beneficiary[type]Type of beneficiary, either "BUSINESS" or "INDIVIDUAL".
beneficiary[country, state, city, address, postCode]Beneficiary's address details: country, state, city, address, and postcode.