All pages
Powered by GitBook
1 of 1

Loading...

Digital Payment

Create a receiver account for paying a Digital CAD Payment

Create a New Digital Receiver Account

POST /api/receiver-account/cad/digital

Headers

Name
Value

Body

Name
Type
Description

* is mandatory parameter

Example body request

Response

x-api-key

<token>

signature

<token>

receiver_id*

string

Receiver ID of receiver account.

recipient*

email

Email address of recipient.

name*

string

Name of recipient.

description

string

Optional description for receiver account.

{
    "receiver_id": "a2bb66db-7067-44a2-8067-1393b682bc75",
    "recipient": "[email protected]",
    "name": "John Doe Inc."
}
{
    "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"
    }
}
{
    "message": "There was an error while creating a receiver account",
    "error": [
        {
            "code": "REAC211",
            "message": "Receiver ID is not valid"
        }
    ]
}