We've launched a new version of our Dev Docs and API Reference! View here →

Variable Recurring Payments

These endpoints enable you to initiate Variable Recurring Payments (VRP). Note, that VRP is also available in Payments v2 API.

Create a VRP consent

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

SecurityBearer or BasicAuth
Request
Request Body schema: application/json
required
required
object (VrpConsentInitiation)

The initiation payload for the VRP consent.

pispConsentAccepted
boolean (pispConsentAccepted)
Default: false

This flag indicates whether the user has granted consent for the payment in the TPP's user interface.

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": false
}
Response samples
application/json
{
  • "vrpConsent": {
    }
}

Get VRP consents

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

SecurityBearer or BasicAuth
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
createdAfter
string

Returns only Vrp consents created after this time (in ISO 8601 format).

Example: createdAfter=2022-04-05T17:00:00.000Z
createdBefore
string

Returns only Vrp consents created before this time (in ISO 8601 format).

Example: createdBefore=2023-04-05T17:00:00.000Z
statuses
Array of strings (VrpConsentStatus)

Filters Vrp consents by statuses

Items Enum: "PENDING" "PENDING_MORE_INFO" "PENDING_REDIRECT_AUTH" "PENDING_REDIRECT_AUTH_VERIFICATION" "AUTHORIZED" "REJECTED" "REVOKED" "FAILED"
Example: statuses=PENDING&statuses=AUTHORIZED
scheme
string (VrpScheme)
Default: "VRP_SWEEPING"

Filters Vrp consents by Vrp scheme (only VRP_SWEEPING is currently supported)

Value: "VRP_SWEEPING"
Example: scheme=VRP_SWEEPING
onBehalfOfId
string

Filters Vrp consents by their onBehalfOfId value.

Example: onBehalfOfId=c5a863bc-86f2-4418-a26f-25b24c7983c7
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.


SecurityBearer or BasicAuth 
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.


SecurityBearer or BasicAuth 
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": {
    }
}
Reconfirm a VRP consent
The POST /vrp-consents/{id}/reconfirm endpoint restarts the inactivity period of an authorized VRP consent and withdraws its inactivity warning. The endpoint can only be used on a consent in AUTHORIZED status whose inactivity is between 12 and 13 months, that is once it has had no activity for 12 months and before it is revoked for inactivity at 13 months.


SecurityBearer or BasicAuth 
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


post/vrp-consents/{id}/reconfirm
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.


SecurityBearer or BasicAuth 
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": {
    }
}
Verify if funds are available or not
The GET /vrps/{id}/confirm-funds endpoint confirms whether the funds are available to initiate VRP.


SecurityBearer or BasicAuth 
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