Skip to main content
Create VRP Payment
curl --request POST \
  --url https://api.yapily.com/variable-recurring-payments/payments \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --header 'consent: <consent>' \
  --data '
{
  "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
  "psuAuthenticationMethod": "SCA_NOT_REQUIRED",
  "psuInteractionType": "PSU_PRESENT",
  "paymentAmount": {
    "amount": 10,
    "currency": "GBP"
  }
}
'
{
  "meta": {
    "tracingId": "0f14e900011b445fa6b6c2c4272d7321"
  },
  "data": {
    "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d",
    "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
    "institutionConsentId": "PF23232222DD",
    "status": "COMPLETED",
    "statusDetails": {
      "status": "COMPLETED",
      "isoStatus": {
        "code": "ACCP",
        "name": "AcceptedCustomerProfile"
      }
    },
    "initiationDetails": {
      "reference": "Own Account Sweeping",
      "payer": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "87654321"
          },
          {
            "type": "SORT_CODE",
            "identification": "654321"
          }
        ]
      },
      "payee": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "12345678"
          },
          {
            "type": "SORT_CODE",
            "identification": "123456"
          }
        ]
      }
    },
    "submissionDetails": {
      "reference": "Own Account Sweeping",
      "payee": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "12345678"
          },
          {
            "type": "SORT_CODE",
            "identification": "123456"
          }
        ]
      },
      "paymentAmount": {
        "amount": 10,
        "currency": "GBP"
      }
    },
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "ACCOUNT_NUMBER",
          "identification": "87654321"
        },
        {
          "type": "SORT_CODE",
          "identification": "654321"
        }
      ]
    },
    "refundAccount": {
      "accountIdentifications": [
        {
          "identification": "400400",
          "type": "SORT_CODE"
        },
        {
          "identification": "99999999",
          "type": "ACCOUNT_NUMBER"
        }
      ],
      "name": "Refund Account"
    },
    "expectedSettlementTime": "2022-03-02T12:00:00.000Z",
    "expectedExecutionTime": "2022-03-02T12:00:00.000Z"
  }
}

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.

Headers

The user's VRP Consent Token

Body

application/json;charset=UTF-8

Mandatory. The payment request object defining the details of the payment for execution under the Variable Recurring Payment consent.

paymentIdempotencyId
string
required

Mandatory. A unique identifier for the payment.

This can be any alpha-numeric string but is limited to a maximum of 35 characters.

psuAuthenticationMethod
string
required

Mandatory. Defines the authentication method(s) allowed in payment submission step. Allowed values are [SCA_REQUIRED, SCA_NOT_REQUIRED].

See SCA.

paymentAmount
Amount Details · object
required

Mandatory. Monetary Amount.

psuInteractionType
string

Conditional. This value is mandatory for Commercial VRP payments. It is one of PSU_PRESENT (ie. the PSU oversees the payment) or PSU_NOT_PRESENT (eg. the payment is async).

Response

Created

meta
object
data
object
forwardedData
object[]
raw
object[]
deprecated