API Reference

Update bill amount of a scheduled RPI instruction

patch
https://sandbox.api.of.ayoconnect.id/api/v2/recurringpayments/billamount

This API allows to update bill amount of a scheduled instruction.

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 32 and 32

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

string
required
length between 14 and 14

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

string
required
length between 14 and 16

Unique identifier for recurring payment instruction.

integer
required

The amount of the transaction. Trailing "00" after decimal(.) is mandatory. e.g. 100.00.

string
required
length between 3 and 3

Currency for the transaction (3-letter currency ISO code).

string
required
length between 11 and 11

Date on which the bill amount has to be updated. The format is DD-MM-YYYY. if there is no instruction scheduled on requested date, the bill amount will be updated for the next scheduled instruction.

Headers
string
required
length between 16 and 16

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

string
required

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

DEPRECATED: 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.

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.

string
required
length between 6 and 6

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

Responses

Updated about 4 hours ago

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

Updated about 4 hours ago