curl --request GET \
--url https://api.yapily.com/variable-recurring-payments/payments/{paymentId}/details \
--header 'Authorization: Basic <encoded-value>' \
--header 'consent: <consent>'{
"meta": {
"tracingId": "679e7bb6cd45416a9a9a8d004c5315da"
},
"data": {
"id": "a9582f8e-08be-4cca-9f01-1ad3be96532d",
"paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
"institutionConsentId": "PF23232222DD",
"status": "COMPLETED",
"statusDetails": {
"status": "COMPLETED",
"isoStatus": {
"code": "ACCP",
"name": "AcceptedCustomerProfile"
}
},
"initiationDetails": {
"reference": "Own Account Sweeping",
"payer": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "87654321"
},
{
"type": "SORT_CODE",
"identification": "654321"
}
]
},
"payee": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "12345678"
},
{
"type": "SORT_CODE",
"identification": "123456"
}
]
}
},
"submissionDetails": {
"reference": "Own Account Sweeping",
"payee": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "12345678"
},
{
"type": "SORT_CODE",
"identification": "123456"
}
]
},
"paymentAmount": {
"amount": 10,
"currency": "GBP"
}
},
"payer": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "87654321"
},
{
"type": "SORT_CODE",
"identification": "654321"
}
]
},
"refundAccount": {
"accountIdentifications": [
{
"identification": "400400",
"type": "SORT_CODE"
},
{
"identification": "99999999",
"type": "ACCOUNT_NUMBER"
}
],
"name": "Refund Account"
},
"expectedSettlementTime": "2022-03-02T12:00:00.000Z",
"expectedExecutionTime": "2022-03-02T12:00:00.000Z"
}
}Get VRP payment details from the Payment ID.
Features: CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING or CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL
curl --request GET \
--url https://api.yapily.com/variable-recurring-payments/payments/{paymentId}/details \
--header 'Authorization: Basic <encoded-value>' \
--header 'consent: <consent>'{
"meta": {
"tracingId": "679e7bb6cd45416a9a9a8d004c5315da"
},
"data": {
"id": "a9582f8e-08be-4cca-9f01-1ad3be96532d",
"paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
"institutionConsentId": "PF23232222DD",
"status": "COMPLETED",
"statusDetails": {
"status": "COMPLETED",
"isoStatus": {
"code": "ACCP",
"name": "AcceptedCustomerProfile"
}
},
"initiationDetails": {
"reference": "Own Account Sweeping",
"payer": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "87654321"
},
{
"type": "SORT_CODE",
"identification": "654321"
}
]
},
"payee": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "12345678"
},
{
"type": "SORT_CODE",
"identification": "123456"
}
]
}
},
"submissionDetails": {
"reference": "Own Account Sweeping",
"payee": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "12345678"
},
{
"type": "SORT_CODE",
"identification": "123456"
}
]
},
"paymentAmount": {
"amount": 10,
"currency": "GBP"
}
},
"payer": {
"name": "John Doe",
"accountIdentifications": [
{
"type": "ACCOUNT_NUMBER",
"identification": "87654321"
},
{
"type": "SORT_CODE",
"identification": "654321"
}
]
},
"refundAccount": {
"accountIdentifications": [
{
"identification": "400400",
"type": "SORT_CODE"
},
{
"identification": "99999999",
"type": "ACCOUNT_NUMBER"
}
],
"name": "Refund Account"
},
"expectedSettlementTime": "2022-03-02T12:00:00.000Z",
"expectedExecutionTime": "2022-03-02T12:00:00.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.
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.
Mandatory. The Consent Token containing the user's authorisation to make the Variable Recurring Payments request.
Mandatory. The Payment Id of the Variable Recurring Payments to retrieve.
Was this page helpful?