ACacquired
Variable Recurring Payments

Retrieve a variable recurring payment

Changed on

Returns a variable recurring payment (VRP) using the unique vrp_id.

get/open-banking/vrps/{vrp_id}

Request

Path parameters

vrp_idstring required

Unique ID assigned by Acquired.com for the variable recurring payment (VRP).

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

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).

status'awaiting_initiation' | 'pending' | 'received' | 'accepted_customer_profile' | 'accepted_technical_validation' | 'accepted_funds_checked' | 'accepted_settlement_in_process' | 'accepted_with_change' | 'partially_accepted_technical_correct' | 'accepted_without_posting' | 'accepted_settlement_completed_debitor_account' | 'accepted_settlement_completed_creditor_account' | 'insufficient_funds' | 'periodic_limit_reached' | 'rejected' | 'cancelled' | 'blocked' | 'failed' | 'unknown'

The machine-readable status of the VRP, at the granularity the bank reports it.

reasonstring

A human-readable explanation of the status. One of Insufficient funds, Periodic limit reached, Amount exceeds maximum per payment limit, Mandate cancelled, Payment initiation has failed, Unexpected status: <status>, Payment did not reach a final status within the allowed time.

end_to_end_identificationstring

End-to-end identification for the payment.

Example response

{
  "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