Skip to main content
Create application VRP configuration by Application Id
curl --request POST \
  --url https://api.yapily.com/applications/{applicationId}/vrp \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "maximumCumulativeNumberOfPayments": 1,
  "periodicLimits": [
    {
      "maximumAmount": {
        "amount": 10,
        "currency": "GBP"
      }
    }
  ],
  "recurringPaymentCategory": "ONGOING"
}
'
{
  "name-is-mandatory": {
    "value": {
      "errors": [
        {
          "fieldName": "name",
          "error": "MANDATORY"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json

The vrp configuration to create

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

Response

Application vrp configuration was successfully created