SpareSpare Docs
GuidesAPI Reference
API Reference

Payments

List and retrieve settled payments.

GET
/payments
Authorization
Header

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

Query

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

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

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payments" \  -H "x-tenant: UAE"
{  "data": [    {      "additionalCreditorAccounts": [        {          "accountHolderName": "string",          "businessName": "string",          "givenName": "string",          "id": "string",          "identification": "string",          "lastName": "string",          "name": "string",          "schemeName": "string"        }      ],      "amount": "string",      "clientId": "string",      "consentPermissions": [        "string"      ],      "createdAt": "2025-01-01T00:00:00Z",      "creditorAccountHolderName": "string",      "creditorAccountId": "string",      "creditorIdentification": "string",      "creditorName": "string",      "creditorReference": "string",      "creditorScheme": "string",      "creditorType": "string",      "currencyCode": "string",      "debtorAccount": {        "identification": "string",        "name": "string",        "schemeName": "string"      },      "debtorReference": "string",      "externalReferenceId": "string",      "failureRedirectUrl": "string",      "id": "string",      "instructions": {        "amount": {          "amount": "string",          "currency": "AED"        },        "copCreditorName": {          "businessName": "string",          "givenName": "string",          "lastName": "string"        },        "currencyRequest": {          "chargeBearer": "BorneByCreditor",          "currencyOfTransfer": "string",          "destinationCountryCode": "string",          "exchangeRateInformation": {            "contractIdentification": "string",            "exchangeRate": 0,            "rateType": "Actual",            "unitCurrency": "AED"          },          "fxQuoteId": "string",          "priority": "Normal",          "purpose": "string"        },        "isInternationalPayment": true,        "maxCumulativeAmount": {          "amount": "string",          "currency": "AED"        },        "maxCumulativeNumberOfPayments": 0,        "paymentSchedule": [          {            "amount": {              "amount": "string",              "currency": "AED"            },            "maxAmount": {              "amount": "string",              "currency": "AED"            },            "paymentExecutionDate": "2025-01-01T00:00:00Z"          }        ],        "periodicSchedule": {          "amount": {            "amount": "string",            "currency": "AED"          },          "controls": {            "maxCumulativeAmountPerPeriod": {              "amount": "string",              "currency": "AED"            },            "maxCumulativeNumberOfPaymentsPerPeriod": 0          },          "endDate": "2025-01-01T00:00:00Z",          "frequency": "Day",          "maxAmount": {            "amount": "string",            "currency": "AED"          },          "startDate": "2025-01-01T00:00:00Z"        },        "permissions": {          "confirmPayee": true,          "readAccountsBasic": true,          "readAccountsDetail": true,          "readBalances": true,          "readRefundAccount": true        }      },      "internalReferenceId": "string",      "isCopPerformed": true,      "merchantCustomerId": "string",      "paymentExecutionDate": "2019-08-24T14:15:22Z",      "paymentType": "string",      "provider": {        "code": "string",        "id": "string",        "logoUrl": "string",        "name": "string",        "status": "string"      },      "purpose": "string",      "risks": {        "BeneficiaryAccountType": "string",        "creditorIndicators": {          "accountType": "string",          "confirmationOfPayeeResponse": "string",          "isCreditorConfirmed": true,          "isCreditorPrePopulated": true,          "isVerifiedByTpp": true        },        "debtorIndicators": {          "biometricCapabilities": {            "biometricTypes": [              "Fingerprint"            ],            "supportsBiometric": true          },          "browserInformation": {            "availableFonts": [              "string"            ],            "isCookiesEnabled": true,            "pixelRatio": 0,            "plugins": [              "string"            ],            "userAgent": "string"          },          "deviceInformation": {            "alternativeDeviceId": "string",            "batteryStatus": {              "isCharging": true,              "level": 0            },            "bindingDuration": "string",            "bindingStatus": "Active",            "connectionType": "WiFi",            "deviceBindingId": "string",            "deviceEnvironmentContext": [              "string"            ],            "deviceId": "string",            "deviceLanguage": "string",            "deviceLocalDateTime": "2025-01-01T00:00:00Z",            "deviceManufacturer": {              "manufacturer": "string",              "model": "string"            },            "deviceOperatingSystem": "string",            "deviceOperatingSystemVersion": "string",            "deviceType": "Mobile",            "lastBindingDateTime": "2025-01-01T00:00:00Z",            "motionSensors": {              "accelerometer": true,              "gyroscope": true,              "status": "InMotion"            },            "screenInformation": {              "orientation": "Portrait",              "pixelDensity": 0            },            "touchSupport": {              "maxTouchPoints": 0,              "supported": true            }          },          "geoLocation": {            "latitude": "string",            "longitude": "string"          },          "userBehavior": {            "scrollBehavior": {              "direction": "Up",              "frequency": 0,              "speed": 0            }          }        },        "DeliveryAddress": {          "AddressLine": [            "string"          ],          "BuildingNumber": "string",          "Country": "AE",          "CountrySubDivision": [            "string"          ],          "PostCode": "string",          "StreetName": "string",          "TownName": "string"        },        "MerchantCategoryCode": "string",        "MerchantCustomerIdentification": "string",        "PaymentContextCode": "string"      },      "status": "string",      "successRedirectUrl": "string",      "updatedAt": "2025-01-01T00:00:00Z"    }  ],  "error": "string",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "meta": {    "currentPageNumber": 0,    "pageSize": 0,    "totalNumberOfPages": 0  }}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "not_found",  "details": {},  "message": "string"}
GET
/payments/{paymentId}
Authorization
Path

UUID of the payment.

Header

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payments/string" \  -H "x-tenant: UAE"
{  "data": {    "error": {      "Code": "string",      "Errors": [        {          "ErrorCode": "string",          "Message": "string",          "Path": "string",          "Url": "string"        }      ],      "Id": "string",      "Message": "string"    },    "message": {      "Data": {        "Charges": [          {            "Amount": {              "Amount": "string",              "Currency": "AED"            },            "ChargeBearer": "string",            "Type": "string"          }        ],        "ConsentId": "string",        "CreationDateTime": "2025-01-01T00:00:00Z",        "DebtorReference": "string",        "DomesticPaymentId": "string",        "ExchangeRate": {          "ContractIdentification": "string",          "ExchangeRate": 0,          "ExpirationDateTime": "2025-01-01T00:00:00Z",          "RateType": "string",          "UnitCurrency": "AED"        },        "Links": {          "Related": "string",          "Self": "string"        },        "OpenFinanceBilling": {          "MerchantId": "string",          "Type": "string"        },        "PaymentId": "string",        "PaymentPurposeCode": "string",        "PaymentTransactionId": "string",        "RejectReasonCode": [          {            "Code": "string",            "Description": "string"          }        ],        "Status": "string",        "StatusUpdateDateTime": "2025-01-01T00:00:00Z"      },      "Links": {        "Related": "string",        "Self": "string"      },      "Meta": {        "TotalPages": 0      }    },    "requestData": {      "error": "string",      "httpMethod": "string",      "idempotencyKey": "string",      "interactionId": "string",      "requestSeconds": 0,      "statusCode": 0,      "url": "string"    },    "signedMessage": "string"  },  "error": "string",  "errorDescription": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "string",  "details": {},  "message": "string"}
{  "code": "not_found",  "details": {},  "message": "string"}
PreviousBank AccountsRegister and manage creditor bank accounts for payment settlement.NextPayment Purpose CodesList valid payment purpose codes for your region.