v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Variable Recurring Payments

List variable recurring payments

Returns a paginated list of variable recurring payments (VRPs).

get/open-banking/vrps

Query parameters

offsetinteger

The record to start the response on.

limitinteger

A limit on the scope of values returned in the response.

customer_idstring uuid

Filter results to cards stored against a specific customer_id.

order_idstring

Example:1c033b5e-4815-4df7-813e-9381aaea06b3

Return all transactions associated with the specified order_id.

end_to_end_identificationstring

Filter by end-to-end identification.

mandate_idstring

Filter by Open Banking mandate identifier.

transaction_idstring uuid

Filter by Acquired transaction identifier.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Response

Example response

{
  "meta": {
    "links": [
      {
        "rel": "first",
        "href": "/v1/path?offset=0",
        "title": "first page"
      }
    ]
  },
  "data": [
    {
      "vrp_id": "01KFBZ1M6H7W0F5H0K7JX2J5Q1",
      "transaction_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "status": "executed",
      "reason": "insufficient_funds",
      "end_to_end_identification": "E2E-123456"
    }
  ]
}