Sign in

v2

latestOpenAPI 3.0.12026-07-2693281951.6 KB
Hosted VRP Pages

Create Hosted Commercial VRP request

Used to initiate a Commercial VRP request using Yapily Hosted Pages.

post/hosted/vrp-requests/commercial

Request body

userIdstring uuid
applicationUserIdstring required
redirectUrlstring required

Mandatory. The URL to redirect to once the Hosted VRP flow finishes.

oneTimeTokenboolean

Optional. Set to true in order for the redirect to return the consent token secured with a one-time token (instead of a plain consent token).

Example request

{
  "controlParameters": {
    "maxAmountPerPayment": {
      "amount": 10,
      "currency": "GBP"
    },
    "periodicLimit": {
      "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"
      }
    }
  }
}

Response

OK