Payment Status API

post

https://sandbox.api.of.ayoconnect.id/dd/api/v3.0/debit/status

This API is used to retrieve the latest Direct Debit payment status and transaction details.

Clients should use latestTransactionStatus as the main reference for the payment status.

Clients may mark the transaction as failed only in the following cases:

latestTransactionStatus is 06 - FAILED, or
response code 4045501 is received from this API, which means the transaction is not found.

If response code 2005500 is received, clients should check the latestTransactionStatus value returned in the response body.

refundHistory contains the history of refund attempts associated with the payment. Multiple records may be returned when more than one refund attempt has been made, including partial, successful, pending, or failed refunds.

For any other error response except 4045501, clients should not mark the transaction as failed.

Clients should retry this API after an appropriate interval to get the latest payment status.

A rate limiter is applied to this API.

Service Code: 55

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchantId

string

required

length between 6 and 6

This field is a 6 char merchant identifier that is unique per each merchant. The exact value is disclosed to each merchant separately.

serviceCode

string

required

Transaction type indicator. Service code of the transaction that needs to be checked (original transaction).

originalReferenceNo

string

required

Use referenceNo value of Payment API response.

Headers

X-TIMESTAMP

string

required

length between 24 and 27

Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format.

X-SIGNATURE

string

required

Represents signature of a request. Symmetric signature: HMAC_SHA512(clientSecret, stringToSign)

stringToSign = HTTPMethod +":"+ URLPath +":"+ AccessToken +":"+ Lowercase(HexEncode(SHA-256(minify(RequestBody))))+":" + X-TIMESTAMP

X-PARTNER-ID

string

required

length between 6 and 6

This field is a 6 char merchant identifier that is unique per each merchant. The exact value is disclosed to each merchant separately.

X-EXTERNAL-ID

string

required

length between 32 and 32

Alphanumeric String. Unique identifier provided by the merchant for each API request. The value must be unique per request attempt and contain 32 alphanumeric characters.

CHANNEL-ID

string

required

length between 5 and 5

Numeric String. PJP's channel id. Device identification on which the API services is currently being accessed by the end user (customer). Must be the same in one flow.

Responses

200This response may indicate either a successful or failed payment.

404Transaction Not Found