v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Variable Recurring Payments

Initiate a variable recurring payment

Allows the initiation of a variable recurring payment against a mandate.

post/open-banking/vrps

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.

Request body

webhook_urlstring uri required

The URL to which webhook notifications should be sent for updates on the payment status.

Example request

{
  "payment": {
    "mandate_id": "01K4VV1HQZ7RFZ4AWA88YTR9Q0"
  },
  "transaction": {
    "order_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "amount": 0.01,
    "currency": "GBP"
  },
  "webhook_url": "https://webhook.site/b693fafa-35dd-47b1-b817-8dc4eb407a2c"
}

Response

vrp_idstring

Unique identifier assigned by Acquired.com for the VRP.

transaction_idstring uuid

Unique identifier assigned by Acquired.com for the transaction (if applicable).

statusstring

VRP status.

reasonstring

Decline reason (when applicable). Possible values include insufficient_funds and periodic_limit_reached.

end_to_end_identificationstring

End-to-end identification for the payment.

Example response

{
  "vrp_id": "01KFBZ1M6H7W0F5H0K7JX2J5Q1",
  "transaction_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "executed",
  "reason": "insufficient_funds",
  "end_to_end_identification": "E2E-123456"
}