Skip to main content
Get application VRP configuration by Application Id
curl --request GET \
  --url https://api.yapily.com/applications/{applicationId}/vrp \
  --header 'Authorization: Basic <encoded-value>'
{
  "maximumIndividualAmount": {
    "amount": 10,
    "currency": "GBP"
  },
  "maximumCumulativeAmount": {
    "amount": 10,
    "currency": "GBP"
  },
  "maximumCumulativeNumberOfPayments": 1,
  "periodicLimits": [
    {
      "maximumAmount": {
        "amount": 10,
        "currency": "GBP"
      },
      "frequency": "MONTHLY",
      "alignment": "CONSENT"
    }
  ],
  "recurringPaymentCategory": "ONGOING"
}

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Path Parameters

​
applicationId
string<uuid>
required

The id of the application that vrp configuration being created for

Response

Application vrp configuration was successfully fetched

​
maximumIndividualAmount
Amount Details · object

Maximum amount per transaction

​
maximumCumulativeAmount
Amount Details · object

Maximum cumulative amount

​
maximumCumulativeNumberOfPayments
integer

Maximum cumulative number of payments

Required range: x >= 0
​
periodicLimits
object[]
Minimum array length: 1
​
recurringPaymentCategory
string

Payment Category with allowed values: ONGOING, SUBSCRIPTION

Example:

"ONGOING"