API Reference

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

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
string
required
length between 16 and 16

Content type accepted by the service. Only 'application/json' is supported.

string
required
length between 16 and 16

Content type returned to the client. Only 'application/json' is supported.

string
required
length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

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.

string
required
length between 6 and 6

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

string
required

Geographical coordinates of the end customer location

string
required

Geographical coordinates of the end customer location.

Responses

Callback

Updated 7 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago