YAyapily
Variable Recurring Payments

Create Sweeping VRP Authorisation

Initiate authorisation for a Sweeping VRP consent.

The response will contain an Authorisation URL and the associated Consent ID. The user will have to complete authorisation of the consent at their institution via Redirect Flows, after which you will be able to use the authorised consent to create payments.

Feature:

  • INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING
post/variable-recurring-payments/sweeping/consents

Request

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

Request body

userUuidstring uuid

Conditional. The Yapily User UUID. One of userUuid or applicationUserId must be present in the request.

applicationUserIdstring

Conditional. The Application User ID. One of userUuid or applicationUserId must be present in the request.

institutionIdstring required

The Institution ID which will carry out authorisation.

callbackstring

Optional. The server to redirect the user to after the user complete the authorisation at the Institution.

See Using a callback (Optional) for more information.

forwardParametersstring[]

Any parameters that you may want to get forwarded in the callback request after the PSU is redirected.

oneTimeTokenboolean

Conditional. Set to true to receive a oneTimeToken instead of consentToken at the callback. This is used for additional security and can only be used when the callback is set.

See Using a One-Time Token for more information.

Example request

{
  "controlParameters": {
    "maxAmountPerPayment": {
      "amount": 10,
      "currency": "GBP"
    },
    "periodicLimits": [
      {
        "totalMaxAmount": {
          "amount": 10,
          "currency": "GBP"
        }
      }
    ]
  },
  "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"
      }
    }
  },
  "complianceData": {
    "payer": {
      "type": "INDIVIDUAL",
      "individual": {
        "name": "John Doe",
        "birthDate": "2000-08-12"
      },
      "business": {
        "name": "Company LTD",
        "registrationNumber": "COM123NO",
        "registeredAddress": {
          "addressLine1": "123 Queens Street",
          "addressLine2": "Unit 13",
          "townName": "York",
          "postCode": "12345",
          "country": "GB"
        },
        "tradingAddress": {
          "addressLine1": "123 Queens Street",
          "addressLine2": "Unit 13",
          "townName": "York",
          "postCode": "12345",
          "country": "GB"
        }
      }
    }
  }
}

Response

Created

linksobject
tracingIdstring

Example response

{
  "data": {
    "controlParameters": {
      "maxAmountPerPayment": {
        "amount": 10,
        "currency": "GBP"
      },
      "periodicLimits": [
        {
          "totalMaxAmount": {
            "amount": 10,
            "currency": "GBP"
          }
        }
      ]
    },
    "payer": {
      "name": "John Doe",
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "401016"
        }
      ],
      "address": {
        "country": "GB"
      }
    },
    "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"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.