Skip to main content
Get Hosted VRP Consent Request
curl --request GET \
  --url https://api.yapily.com/hosted/vrp/consent-requests/{consentRequestId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "meta": {
    "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0"
  },
  "data": {
    "id": "ad4bfe58-6352-11ee-8c99-0242ac120002",
    "applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002",
    "applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64",
    "institutionIdentifiers": {
      "institutionId": "modelo-sandbox",
      "institutionCountryCode": "GB"
    },
    "userSettings": {
      "language": "en",
      "location": "GB"
    },
    "redirectUrl": "https://tpp-application.com",
    "vrpSetup": {
      "payer": {
        "accountIdentifications": [
          {
            "type": "MASKED_ACCOUNT_NUMBER",
            "identification": "*****493"
          }
        ]
      },
      "payee": {
        "name": "Merchant Doe",
        "accountIdentifications": [
          {
            "identification": "401016",
            "type": "SORT_CODE"
          },
          {
            "identification": "71518920",
            "type": "ACCOUNT_NUMBER"
          }
        ]
      },
      "reference": "Test Payment",
      "limits": {
        "periodicLimits": [
          {
            "maxAmount": {
              "amount": 100,
              "currency": "GBP"
            },
            "frequency": "MONTHLY",
            "alignment": "CALENDAR"
          }
        ],
        "maxAmountPerPayment": {
          "amount": 10,
          "currency": "GBP"
        }
      },
      "validFrom": "2023-10-04T16:41:17.870Z",
      "validTo": "2024-10-04T16:41:17.870Z",
      "recurringPaymentCategory": "ONGOING",
      "risk": {
        "contextType": "ECOMMERCE_MERCHANT"
      }
    },
    "createdAt": "2023-10-05T07:56:44.552Z",
    "authorisationExpiresAt": "2023-10-05T07:56:44.552Z",
    "consentStatus": "AUTHORIZED",
    "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
    "phases": [
      {
        "phaseName": "INITIATED",
        "phaseCreatedAt": "2023-05-10T07:56:54.887Z"
      },
      {
        "phaseName": "INPUT_CAPTURED",
        "phaseCreatedAt": "2023-05-10T07:57:05.123Z"
      },
      {
        "phaseName": "VALIDATION_COMPLETED",
        "phaseCreatedAt": "2023-05-10T07:57:05.223Z"
      },
      {
        "phaseName": "AUTHORISATION_CREATED",
        "phaseCreatedAt": "2023-05-10T07:57:06.637Z"
      },
      {
        "phaseName": "AUTHORISED",
        "phaseCreatedAt": "2023-05-10T07:57:10.637Z"
      },
      {
        "phaseName": "SUBMITTED",
        "phaseCreatedAt": "2023-05-10T07:57:10.654Z"
      },
      {
        "phaseName": "ACCEPTED",
        "phaseCreatedAt": "2023-05-10T07:57:11.867Z"
      }
    ]
  }
}

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

sub-application
string

The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)

Path Parameters

Unique Identifier of the Consent Request

Response

Ok

meta
object
data
object