Skip to main content
Get VRP payment
curl --request GET \
  --url https://api.yapily.com/hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "meta": {
    "tracingId": "d80a638a-635e-11ee-8c99-0242ac120002"
  },
  "data": {
    "id": "string",
    "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
    "amount": {
      "amount": 10,
      "currency": "GBP"
    },
    "reference": "Test Payment",
    "payee": {
      "name": "Merchant Doe",
      "accountIdentifications": [
        {
          "identification": "401016",
          "type": "SORT_CODE"
        },
        {
          "identification": "71518920",
          "type": "ACCOUNT_NUMBER"
        }
      ]
    },
    "refundAccount": {
      "name": "string",
      "accountIdentifications": [
        {
          "type": "MASKED_ACCOUNT_NUMBER",
          "identification": "*****493"
        }
      ]
    },
    "paymentLifecycleId": "234g87t58tgeuo848wudjew489",
    "institutionPaymentId": "35a4bd02-635e-11ee-8c99-0242ac120002",
    "statusDetails": {
      "status": "COMPLETED",
      "statusUpdateDate": "2023-10-05T09:00:36.360Z",
      "isoStatus": {
        "code": "ACSC",
        "name": "AcceptedSettlementCompleted"
      }
    }
  }
}

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

paymentId
string
required

Unique Identifier of the Consent Request

Response

Ok

meta
object
data
object