Get recurring payment instruction details

get

https://sandbox.api.of.ayoconnect.id/api/v2/recurringpayments/{code}

The API returns a 200 HTTP response code in case of a successful 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).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code

string

required

length between 14 and 16

Unique identifier for recurring payment instruction.

Query Params

transactionId

string

required

length between 32 and 32

Transaction id. 32 alphanumeric characters. It should be unique per request.

customerId

string

required

length between 13 and 14

Customer Code. It is used to identify the customer.

merchantCode

string

required

length between 6 and 6

Merchant Code. 6 alphanumeric characters. It is used to identify the merchant.

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.

Authorization

string

required

length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

X-Correlation-ID

string

required

length between 32 and 32

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

A flow is a set of API calls, for example, all the calls related to payment are part of one flow.

Merchants can link API calls into one flow using this header.

NOTE: The 'A-Correlation-ID' header is being deprecated so, this new header is replacing it. For some time, both headers can be used but in October 2024, the 'A-Correlation-ID' header will be finally removed from the API.

Responses

200Recurring Payment Instruction details

400Bad Request

401If Authorization token is missing or expired.

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