Skip to main content
Create Hosted Commercial VRP request
curl --request POST \
  --url https://api.yapily.com/hosted/vrp-requests/commercial \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "userId": "00000000-0000-0000-0000-000000000000",
  "applicationUserId": "any",
  "userSettings": {
    "language": "EN",
    "location": "GB"
  },
  "institutionIdentifiers": {
    "institutionId": "mock-sandbox",
    "institutionCountryCode": "GB"
  },
  "controlParameters": {
    "maxAmountPerPayment": {
      "amount": 1.23,
      "currency": "GBP"
    },
    "periodicLimit": {
      "frequency": "MONTHLY",
      "maxAmount": {
        "amount": 2.46,
        "currency": "GBP"
      }
    },
    "validFrom": "2026-01-01T00:00:00Z",
    "validTo": "2027-02-02T11:59:59Z"
  },
  "initiationDetails": {
    "reference": "Test",
    "payee": {
      "name": "Mr. Beneficiary",
      "accountIdentifications": [
        {
          "type": "SORT_CODE",
          "identification": "112233"
        },
        {
          "type": "ACCOUNT_NUMBER",
          "identification": "12345678"
        }
      ]
    }
  },
  "redirectUrl": "https://parameter-viewer.yapily.com/",
  "oneTimeToken": true,
  "riskDetails": {
    "paymentContextCode": "TransferToThirdParty",
    "paymentPurposeCode": "OTHR",
    "categoryPurposeCode": "OTHR",
    "merchantCustomerId": "00000000-0000-0000-0000-000000000000",
    "isPayeePrepopulated": false,
    "payeeAccountType": "Personal"
  }
}
'
{
  "meta": {
    "tracingId": "12345678901234567890123456789012"
  },
  "data": {
    "requestId": "00000000-0000-0000-0000-000000000000",
    "institutionIdentifiers": {
      "institutionId": "mock-sandbox",
      "institutionCountryCode": "GB"
    },
    "userSettings": {
      "language": "EN",
      "location": "GB"
    },
    "hostedUrl": "https://...",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "authorisationExpiresAt": "2027-02-02T11:59:59.000Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yapily.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

application/json
applicationId
string<uuid>
required
applicationUserId
string
required
institutionIdentifiers
object
required
controlParameters
object
required

Mandatory. The parameters for the VRP mandate.

redirectUrl
string
required

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

riskDetails
object
required

Mandatory. The details required by the institutions to detect and prevent fraud.

userId
string<uuid>
userSettings
object
initiationDetails
object

Optional. The details of the participating parties.

oneTimeToken
boolean

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

Response

OK

meta
object
required
data
object
required