Skip to main content
Create Variable Recurring 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",
  "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

Mandatory. The consent-token containing the user's authorisation to make the request.

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 that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.

Example:

"04ab4536gaerfc0e1f93c4f4"

psuAuthenticationMethod
string
required

Mandatory. Chosen authentication method for submission step. Allowed values are [SCA_REQUIRED, SCA_NOT_REQUIRED].

paymentAmount
Amount Details · object
required

Mandatory. Monetary Amount.

Response

Created

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