Variable Recurring Payments

These endpoints enable you to initiate Variable Recurring Payments (VRP).

Create a VRP consent

The POST /vrp-consents endpoint creates a new VRP consent.

SecurityBasicAuth or Bearer
Request
Request Body schema: application/json
required
required
object (VrpConsentInitiation)

The initiation payload for the VRP consent.

pispConsentAccepted
boolean

A flag confirming that the user has accepted the Payment Initiation Service Provider's (PISP) consent. This field is only required for TPPs using Token.io's licence.

Responses
200

Successful response

400

Bad request

401

The authorization information is missing or invalid

403

Permission to access this endpoint is denied

500

An unexpected or internal server error

post/vrp-consents
Request samples
application/json
{
  • "initiation": {
    },
  • "pispConsentAccepted": true
}
Response samples
application/json
{
  • "vrpConsent": {
    }
}

Get VRP consents

The GET /vrp-consents endpoint retrieves all VRP consents created by the calling member.

SecurityBasicAuth or Bearer
Request
query Parameters
limit
required
integer <int32> [ 1 .. 200 ]

The maximum number of records to return.

Example: limit=10
offset
string

The offset from the previous page.

Example: offset=LerV6Jmex
Responses
200

Successful response

400

Bad request

401

The authorization information is missing or invalid

500

An unexpected or internal server error

get/vrp-consents
Request samples 
Response samples 
application/json
{
  • "vrpConsents": [
    ],
  • "pageInfo": {
    }
}
Get a VRP consent
The GET /vrp-consents/{id} endpoint retrieves the details for an individual VRP consent.


SecurityBasicAuth or Bearer 
Request 
path Parameters
id
required
string
VRP consent id


 
 Example:  vc:12345abcd:abcde
Responses 
200
Successful response


401
The authorization information is missing or invalid


404
VRP consent not found


500
An unexpected or internal server error


get/vrp-consents/{id}
Request samples 
Response samples 
application/json
{
  • "vrpConsent": {
    }
}
Revoke a VRP consent
The DELETE /vrp-consents/{id} endpoint revokes an individual VRP consent.


SecurityBasicAuth or Bearer 
Request 
path Parameters
id
required
string
VRP consent id


 
 Example:  vc:12345abcd:abcde
Responses 
200
Successful response


401
The authorization information is missing or invalid


404
VRP consent not found


500
An unexpected or internal server error


delete/vrp-consents/{id}
Request samples 
Response samples 
application/json
{
  • "vrpConsent": {
    }
}
Get payments under a VRP consent
The GET /vrp-consents/{id}/payments endpoint retrieves the payments under a given VRP consent.


SecurityBasicAuth or Bearer 
Request 
path Parameters
id
required
string
VRP consent id


 
 Example:  vc:12345abcd:abcde
query Parameters
limit
required
integer <int32>   [ 1 .. 200 ] 
The maximum number of records to return.


 
 Example:  limit=10
offset
string
The offset from the previous page.


 
 Example:  offset=LerV6Jmex
Responses 
200
Successful response


400
Bad request


401
The authorization information is missing or invalid


500
An unexpected or internal server error


get/vrp-consents/{id}/payments
Request samples 
Response samples 
application/json
{
  • "vrps": [
    ],
  • "pageInfo": {
    }
}
Initiate a VRP payment
The POST /vrps initiates a new VRP payment.


SecurityBasicAuth or Bearer 
Request 
Request Body schema: application/json
required
required
object (VrpInitiation) 
The VRP initiation object.


 
Responses 
200
Successful response


400
Bad request


401
The authorization information is missing or invalid


403
Permission to access this endpoint is denied


404
VRP consent not found


500
An unexpected or internal server error


post/vrps
Request samples 
application/json
{
  • "initiation": {
    }
}
Response samples 
application/json
{
  • "vrp": {
    }
}
Get VRP payments
The GET /vrps endpoint provides you with a list of vrp payments and their details.


SecurityBasicAuth or Bearer 
Request 
query Parameters
limit
required
integer <int32>   [ 1 .. 200 ] 
The maximum number of records to return.


 
 Example:  limit=10
offset
string
The offset from the previous page.


 
 Example:  offset=LerV6Jmex
ids
Array of strings
Filters vrp payments by their ids - returns only payments with ids listed in this parameter.


 
 Example:  ids=vrp:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN&ids=vrp:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA
invertIds
boolean
Invert ids query - returns only vrp payments with ids not listed in the ids parameter.


 
statuses
Array of strings (VrpStatus) 
Filters vrp payments by their statuses - returns only payments with statuses listed in this parameter.


Items Enum: "INITIATION_PENDING" "INITIATION_PROCESSING" "INITIATION_COMPLETED" "INITIATION_REJECTED" "INITIATION_REJECTED_INSUFFICIENT_FUNDS" "INITIATION_FAILED" "INITIATION_NO_FINAL_STATUS_AVAILABLE"  
 Example:  statuses=INITIATION_COMPLETED&statuses=INITIATION_REJECTED
invertStatuses
boolean
Invert statuses query - returns only vrp payments with statuses not listed in the statuses parameter.


 
 Example:  invertStatuses=true
createdAfter
string
Returns only vrp payments created after this time (in ISO 8601 format).


 
 Example:  createdAfter=2022-04-05T17:00:00.000Z
createdBefore
string
Returns only vrp payments created before this time (in ISO 8601 format).


 
 Example:  createdBefore=2022-04-05T17:00:00.000Z
refIds
Array of strings
Filters vrp payments by their refId values - returns only payments with refIds listed in this parameter.


 
 Example:  refIds=ShBdcTeqFabqJJhUF&refIds=N5cJDFsQzVca3Q
vrpConsentId
string
Filters vrp payments by their VRP consent id value - returns only payments with vrpConsentId listed in this parameter.


 
 Example:  vrpConsentId=vc:12345abcd:abcde
Responses 
200
Successful response


400
The client specified an invalid argument.


401
The authorization information is missing or invalid


500
An unexpected or internal server error


get/vrps
Request samples 
Response samples 
application/json
{
  • "vrps": [
    ],
  • "pageInfo": {
    }
}
Get a VRP payment
The GET /vrps/{id} endpoint retrieves the details for an individual VRP payment.


SecurityBasicAuth or Bearer 
Request 
path Parameters
id
required
string
VRP id


 
 Example:  vrp:12345abcd:abcde
Responses 
200
Successful response


401
The authorization information is missing or invalid


404
Not found


500
An unexpected or internal server error


get/vrps/{id}
Request samples 
Response samples 
application/json
{
  • "vrp": {
    }
}
Verify if funds are available or not
The GET /vrps/{id}/confirm-funds endpoint confirms whether the funds are available to initiate VRP.


SecurityBasicAuth or Bearer 
Request 
path Parameters
id
required
string
The VRP consent id.


 
 Example:  vc:12345abcd:abcde
query Parameters
amount
required
string
The amount to confirm availability for.


 
 Example:  amount=1
Responses 
200
Successful response


401
The authorization information is missing or invalid


404
Not found


500
An unexpected or internal server error


get/vrps/{id}/confirm-funds
Request samples 
Response samples 
application/json
{
  • "fundsAvailable": false
}
➔ Next to Refunds - BETA