Add Beneficiary

post

https://sandbox.api.of.ayoconnect.id/api/v1/bank-disbursements/beneficiary

This API generates an unique identifier for the beneficiary.

The API returns a 202 HTTP response code in case of a processing response.

The API returns a 400 HTTP response code in case of a bad request (for example, missing and/or wrong headers).

The API returns a 401 HTTP response code in case of a missing or invalid token.

The API returns a 412 HTTP response code in case of a validation error (for example, missing and/or wrong parameters).

In case of either 503 or 504 HTTP response code received in the response, please hit the ‘Add Beneficiary’ API again.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API generates an unique identifier for the beneficiary.

The API returns a 202 HTTP response code in case of a processing response.

The API returns a 400 HTTP response code in case of a bad request (for example, missing and/or wrong headers).

The API returns a 401 HTTP response code in case of a missing or invalid token.

The API returns a 412 HTTP response code in case of a validation error (for example, missing and/or wrong parameters).

In case of either 503 or 504 HTTP response code received in the response, please hit the ‘Add Beneficiary’ API again.

Body Params

transactionId

string

required

length between 32 and 32

The transaction identifier. A 32-character alphanumeric string. It should be unique for each request but no 'idempotency check' is implemented on this field.

phoneNumber

string

required

length between 9 and 13

Customer phone number. It should start with the Indonesian country code '62' and be followed by, at least 9, numeric characters (and a maximum of 13 numeric characters).

customerDetails

object

required

Customer details.

beneficiaryAccountDetails

object

required

Beneficiary account details.

Headers

A-Correlation-ID

string

required

length between 32 and 32

Unique identifier (32 alphanumeric characters) to identify the request. It must be unique per request and can't be reused in subsequent requests.

If the same value is used in another request, it will be considered as a duplicated request, and consequently rejected.

A-Merchant-Code

string

required

length between 6 and 6

Unique identifier (6 alphanumeric characters) to identify the particular merchant. It must be unique per merchant.

A-Latitude

string

required

Geographical coordinates of the end customer location

A-Longitude

string

required

Geographical coordinates of the end customer location.

Responses

Callback

202Request accepted and it's processing

400Bad Request

401If Authorization token is missing or expired.

412If an invalid input parameter is passed then we get a validation error.

501Not Supported.

503Service is temporarily unavailable due to an internal error, service down or system under maintenance.

504Server Timeout.