Skip to main content
Confirm Funds for Variable Recurring Payment
curl --request POST \
  --url https://api.yapily.com/variable-recurring-payments/funds-confirmation \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --header 'consent: <consent>' \
  --data '
{
  "reference": "Own Account Sweeping",
  "paymentAmount": {
    "amount": 10,
    "currency": "GBP"
  }
}
'
{
  "meta": {
    "tracingId": "0f14e900011b445fa6b6c2c4272d7321"
  },
  "data": {
    "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d",
    "fundsAvailable": {
      "fundsAvailable": true,
      "fundsAvailableAt": "2021-06-08T10:59:35.138Z"
    },
    "reference": "Own Account Sweeping",
    "paymentAmount": {
      "amount": 10,
      "currency": "GBP"
    }
  }
}

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

The fund confirmation object defining the details of the account and funds to be checked under the Variable Recurring Payment consent.

paymentAmount
Amount Details · object
required

Mandatory. Monetary Amount.

reference
string

Optional. The payment reference or description. Limited to a maximum of 18 characters long.

Example:

"Own Account Sweeping"

Response

Created

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