YAyapily
Variable Recurring Payments

Create VRP Payment

Changed on

Submit payment on the VRP consent.

Required feature: CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING or CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL

post/variable-recurring-payments/payments

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Headers

consentstring required

The user's VRP Consent Token

Request body

paymentIdempotencyIdstring required

Mandatory. A unique identifier for the payment.

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

psuAuthenticationMethodstring required

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

See SCA.

psuInteractionTypestring

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).

Example request

{
  "paymentAmount": {
    "amount": 10,
    "currency": "GBP"
  }
}

Response

Created

linksobject
tracingIdstring

Example response

{
  "data": {
    "statusDetails": {
      "isoStatus": {
        "code": "ACCC",
        "name": "AcceptedCreditSettlementCompleted"
      }
    },
    "initiationDetails": {
      "payer": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "ultimatePayer": {
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      },
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "ultimatePayee": {
        "accountIdentifications": [
          {
            "type": "SORT_CODE",
            "identification": "401016"
          }
        ],
        "address": {
          "country": "GB"
        }
      }
    },
    "submissionDetails": {
      "reference": "Own Account Sweeping",
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ],
        "address": {
          "country": "GB"
        },
        "merchantId": "24589303",
        "merchantCategoryCode": "0742"
      },
      "paymentAmount": {
        "amount": 10,
        "currency": "GBP"
      }
    },
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ],
      "address": {
        "country": "GB"
      }
    },
    "refundAccount": {
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ]
    }
  }
}

Changes