ACacquired
Variable Recurring Payments

Initiate a variable recurring payment

Changed on

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

post/open-banking/vrps

Request

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

OK

transaction_idstring uuid

Unique identifier assigned by Acquired.com for the transaction.

status'pending' | 'executed' | 'declined' | 'blocked'

The machine-readable outcome of the collection attempt.

reasonstring

A human-readable explanation of a declined status. One of insufficient_funds, Periodic limit reached, Amount exceeds maximum per payment limit, Payment initiation has failed, Unexpected status: <status>, or a bank status reason passed through as <code> - <description>. A payment declined because the bank rejected it, or because the mandate was no longer active, carries no reason.

Example response

{
  "transaction_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "pending",
  "reason": "insufficient_funds",
  "links": [
    {
      "rel": "self",
      "href": "/v1/transactions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ]
}

Changes

  • 9c9e8ec96e98Revision changes
    • warning

      changed the pattern of the request property / from ^[A-Za-z]{3}$ to ^[A-Z]{3}$

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

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

    • warning

      added the new declined enum value to the response property for the response status

    • warning

      added the new executed 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