Direct Credit

Create a new receiver account for receiverDirect Credit

NZD Direct Credit Payments will be available 31/03/2025. Please speak with your account manager for more information.

Create a New Direct Credit Receiver Account

POST /api/receiver-account/nzd/direct-credit

Headers

Name	Value
x-api-key	<token>
signature	<token>

Body

Name	Type	Description
receiver_id*	string	Receiver ID of receiver account.
account_number*	string	In format of BBBBBB-AAAAAAA-SSS * *

* is mandatory parameter * * BBBBBB = Bank & branch code (6 digits) , AAAAAAA = Account number (7 digits), SSS = Suffix (2-3 digits)

Example body request

{
    "receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
    "account_number": "123456-0789123-00"
}

Response

200

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

400

{
    "message": "There was an error while creating a receiver account",
    "error": [
        {
            "code": "REAC211",
            "message": "Receiver ID is not valid"
        }
    ]
}