Disbursement status

get

https://sandbox.api.of.ayoconnect.id/api/v1/bank-disbursements/status/{correlationId}

This API will return disbursement status.

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 any HTTP response code other than 202 received in the response, please ‘DO NOT FAIL’ the transactions. Instead, hit the ‘Check Status’ API or wait for the callback to receive the final status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

correlationId

string

required

length between 32 and 32

Unique identifier (32 alphanumeric characters) to identify a previous 'disbursement' request (the 'A-Correlation-ID' header value will be used to clearly identify the request so, both fields must contain different values).

Query 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.

transactionReferenceNumber

string

length between 32 and 32

transactionReferenceNumber. 32 alphanumeric characters. Reference number received from ayoconnect at the time of disbursement .

beneficiaryId

string

required

length between 13 and 13

beneficiaryId. Unique Identifier for beneficiary

customerId

string

required

length between 14 and 14

Customer Code. 14 characters. It is used to identify the customer.

Headers

Content-Type

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.

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.

Authorization

string

required

length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

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-IP-Address

string

required

length between 7 and 15

Public Ip Address of the end customer

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.

503If an internal error or service down then we get a internal server error.

504Server Timeout.