ACacquired
Variable Recurring Payments

List variable recurring payments

Changed on

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

get/open-banking/vrps

Request

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

OK

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": "accepted_settlement_completed_creditor_account",
      "reason": "Insufficient funds",
      "end_to_end_identification": "E2E-123456"
    }
  ]
}

Changes

  • 9c9e8ec96e98Revision changes
    • warning

      added the new accepted_customer_profile enum value to the /// response property for the response status

    • warning

      added the new accepted_funds_checked enum value to the /// response property for the response status

    • warning

      added the new accepted_settlement_completed_creditor_account enum value to the /// response property for the response status

    • warning

      added the new accepted_settlement_completed_debitor_account enum value to the /// response property for the response status

    • warning

      added the new accepted_settlement_in_process enum value to the /// response property for the response status

    • warning

      added the new accepted_technical_validation enum value to the /// response property for the response status

    • warning

      added the new accepted_with_change enum value to the /// response property for the response status

    • warning

      added the new accepted_without_posting enum value to the /// response property for the response status

    • warning

      added the new awaiting_initiation enum value to the /// response property for the response status

    • warning

      added the new blocked enum value to the /// response property for the response status

    • warning

      added the new cancelled enum value to the /// response property for the response status

    • warning

      added the new failed enum value to the /// response property for the response status

    • warning

      added the new insufficient_funds enum value to the /// response property for the response status

    • warning

      added the new partially_accepted_technical_correct enum value to the /// response property for the response status

    • warning

      added the new pending enum value to the /// response property for the response status

    • warning

      added the new periodic_limit_reached enum value to the /// response property for the response status

    • warning

      added the new received enum value to the /// response property for the response status

    • warning

      added the new rejected enum value to the /// response property for the response status

    • warning

      added the new unknown enum value to the /// response property for the response status