paymentRequests

Payment Requests Get

get/payment-requests/{paymentRequestId}

Request

Base URL: https://api.sandbox.tryspare.ae
URL: https://api.sandbox.tryspare.ae/payment-requests/{paymentRequestId}
Auth: HTTP bearer

Path parameters

paymentRequestIdstring required

UUID of the payment request.

Headers

x-tenantstring required

Example:UAE

Regulatory jurisdiction the request routes to (e.g. UAE, KSA, MAIN). Match it to the market you're integrating.

Response

Success response

errorstring nullable

errorDescriptionobject nullable

Example response

{
  "data": {
    "createdAt": "2025-01-01T00:00:00Z",
    "currency": "AED",
    "instructions": {
      "amount": {
        "currency": "AED"
      },
      "currencyRequest": {
        "exchangeRateInformation": {
          "unitCurrency": "AED"
        }
      },
      "maxCumulativeAmount": {
        "currency": "AED"
      },
      "paymentSchedule": [
        {
          "amount": {
            "currency": "AED"
          },
          "maxAmount": {
            "currency": "AED"
          },
          "paymentExecutionDate": "2025-01-01T00:00:00Z"
        }
      ],
      "periodicSchedule": {
        "amount": {
          "currency": "AED"
        },
        "controls": {
          "maxCumulativeAmountPerPeriod": {
            "currency": "AED"
          }
        },
        "endDate": "2025-01-01T00:00:00Z",
        "maxAmount": {
          "currency": "AED"
        },
        "startDate": "2025-01-01T00:00:00Z"
      }
    },
    "risks": {
      "debtorIndicators": {
        "deviceInformation": {
          "deviceLocalDateTime": "2025-01-01T00:00:00Z",
          "lastBindingDateTime": "2025-01-01T00:00:00Z"
        }
      },
      "DeliveryAddress": {
        "Country": "AE"
      }
    },
    "updatedAt": "2025-01-01T00:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.