payments

Payments List

get/payments

Request

  • Base URL: https://api.sandbox.tryspare.ae
  • URL: https://api.sandbox.tryspare.ae/payments
  • Auth: HTTP bearer

Query parameters

pagenumber

1-based page number for paginated results. Defaults to the first page.

perPagenumber

Number of items to return per page. Defaults to the API's page size.

externalReferencestring

Filter results by your own reference set when the resource was created.

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",
      "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.