YAyapily
Payments

Get Payment Details

Returns the details of a payment.

Most commonly used to check for payment status updates.

Feature: EXISTING_PAYMENTS_DETAILS

get/payments/{paymentId}/details

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

paymentIdstring required

Mandatory. The payment Id of the payment.

Headers

consentstring required

Mandatory. The consent-token containing the user's authorisation to make the request.

psu-idstring

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

psu-corporate-idstring

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

psu-ip-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Response

Ok

linksobject
tracingIdstring

Example response

{
  "data": {
    "payments": [
      {
        "statusDetails": {
          "isoStatus": {
            "code": "ACCC",
            "name": "AcceptedCreditSettlementCompleted"
          }
        },
        "payer": {
          "name": "John Doe",
          "accountIdentifications": [
            {
              "type": "SORT_CODE",
              "identification": "401016"
            }
          ],
          "address": {
            "country": "GB"
          }
        },
        "payeeDetails": {
          "name": "Jane Doe",
          "accountIdentifications": [
            {
              "identification": "401016",
              "type": "SORT_CODE"
            },
            {
              "identification": "71518920",
              "type": "ACCOUNT_NUMBER"
            }
          ],
          "address": {
            "country": "GB"
          },
          "merchantId": "24589303",
          "merchantCategoryCode": "0742"
        },
        "amountDetails": {
          "amount": 10,
          "currency": "GBP"
        },
        "firstPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "nextPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "finalPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "previousPaymentAmount": {
          "amount": 10,
          "currency": "GBP"
        },
        "chargeDetails": [
          {
            "chargeAmount": {
              "amount": 10,
              "currency": "GBP"
            }
          }
        ],
        "refundAccount": {
          "accountIdentifications": [
            {
              "type": "SORT_CODE",
              "identification": "401016"
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.