Add AU Bank Account

Create a new receiver account for receiver

Create a New Receiver Account

POST /api/receiveraccount

Headers

NameValue

x-api-key

<token>

signature

<token>

Body

NameTypeDescription

receiver_id*

string

Receiver ID of receiver account.

account_type*

string

Account Type of receiver account. 'I' is 'Individual' and 'B' is Business

bsb*

string

BSB of receiver account.

account_number*

string

Account number of receiver account.

aka

string

Alias name of receiver account.

occupation

string

Occupation of receiver account holder.

homedialcode

string

Home Dialcode of receiver account holder.

homephone

string

Homephone of receiver account holder.

abn

string

ABN of receiver account.

acn

string

ACN of receiver account.

nzbn

string

NZBN of receiver account.

* is mandatory parameter

Example body request

{
    "receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
    "account_type": "I", // For 'Individual'
    "bsb": "012002",
    "account_number": "111136"
}

Response

{
    "message": "Receiver account created successfully",
    "payload": {
        "receiver_account_id": "c7ded40b-1524-49f4-ae3f-ee974cbe6fdd",
        "receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
        "bsb": "012003",
        "account_number": "712179",
        "status": "pending",
        "confirm_status": "unconfirmed"
    }
}

Last updated