Payment Requests

Response Body

`application/json`

curl -X GET "https://example.com/payment-requests" \  -H "x-tenant: UAE"

{  "data": [    {      "additionalCreditorAccounts": [        {          "accountHolderName": "string",          "businessName": "string",          "givenName": "string",          "id": "string",          "identification": "string",          "lastName": "string",          "name": "string",          "schemeName": "IBAN"        }      ],      "amount": "string",      "createdAt": "2025-01-01T00:00:00Z",      "creditorAccount": {        "accountHolderName": "string",        "businessName": "string",        "givenName": "string",        "id": "string",        "identification": "string",        "lastName": "string",        "name": "string",        "schemeName": "IBAN"      },      "creditorReference": "string",      "creditorType": "string",      "currency": "AED",      "debtorAccount": {        "accountHolderName": "string",        "businessName": "string",        "givenName": "string",        "id": "string",        "identification": "string",        "lastName": "string",        "name": "string",        "schemeName": "IBAN"      },      "debtorReference": "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        }      },      "internalReference": "string",      "isCopVerified": true,      "merchantId": "string",      "merchantReference": "string",      "provider": {        "code": "string",        "id": "string",        "logoUrl": "string",        "name": "string",        "status": "string"      },      "purpose": "string",      "redirectUrl": "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": "New",      "successRedirectUrl": "string",      "type": "SingleInstantPayment",      "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"}

POST

/payment-requests

Authorization

Authorization (Header)string

Header

x-signature*string

ES256 request signature. Required on signed-write endpoints, see [request signing](/docs/quickstart/request-signing).

x-customer-idstring

Optional merchant-supplied customer UUID for debtor account tagging. Must be a valid UUID.

x-tenant*string

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

Body

*object

array<object>

channelstring

array<string>

object

creditorReferencestring

creditorType*string

object

debtorReferencestring

failureRedirectUrlstring

object

merchantReference*string

providerIdstring

purpose*string

object

savedDebtorAccountIdstring

successRedirectUrlstring

type*string

Request Body

application/json

additionalCreditorAccounts?array<>

channel?LinkOriginChannel

consentPermissions?array<string>

Data permissions the consent grants (e.g. read balances, read transactions).

creditorAccount*

The payee (creditor) account that receives the funds.

creditorReference?string

Your reference for the creditor/payee, echoed back for reconciliation.

creditorType*string

Type of creditor (e.g. MERCHANT).

debtorAccount?

The payer (debtor) account the funds are collected from.

debtorReference?string

Your reference for the debtor/payer.

failureRedirectUrl?string

URL to redirect the payer to after a failed or cancelled authorization.

instructions*

merchantReference*string

Your merchant reference for this transaction, echoed back for reconciliation.

providerId?Optional preselected provider UUID used to bypass bank selection.

Format: UUID.

purpose*string

Payment purpose code, see the payment purpose codes reference.

risks?

Risk metadata for the payment (e.g. delivery address, merchant category).

savedDebtorAccountId?Reference to a previously-captured saved debtor account.

Mutually exclusive with `debtorAccount`. Requires `x-customer-id` header.

successRedirectUrl?string

URL to redirect the payer to after a successful authorization.

type*string

The payment request type, for example SingleInstantPayment. Determines which other fields are required.

Response Body

`application/json`

curl -X POST "https://example.com/payment-requests" \  -H "x-signature: string" \  -H "x-tenant: UAE" \  -H "Content-Type: application/json" \  -d '{    "amount": "125.50",    "beneficiaryIban": "AE070331234567890123456",    "beneficiaryName": "Acme Supplier LLC",    "currency": "AED",    "reference": "INV-10042"  }'

{  "data": {    "amount": "125.50",    "currency": "AED",    "internalReferenceId": "req_01hqnx2w",    "status": "New"  }}

{  "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"}

Response Body

`application/json`

curl -X GET "https://example.com/payment-requests/string" \  -H "x-tenant: UAE"

{  "data": {    "additionalCreditorAccounts": [      {        "accountHolderName": "string",        "businessName": "string",        "givenName": "string",        "id": "string",        "identification": "string",        "lastName": "string",        "name": "string",        "schemeName": "IBAN"      }    ],    "amount": "string",    "createdAt": "2025-01-01T00:00:00Z",    "creditorAccount": {      "accountHolderName": "string",      "businessName": "string",      "givenName": "string",      "id": "string",      "identification": "string",      "lastName": "string",      "name": "string",      "schemeName": "IBAN"    },    "creditorReference": "string",    "creditorType": "string",    "currency": "AED",    "debtorAccount": {      "accountHolderName": "string",      "businessName": "string",      "givenName": "string",      "id": "string",      "identification": "string",      "lastName": "string",      "name": "string",      "schemeName": "IBAN"    },    "debtorReference": "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      }    },    "internalReference": "string",    "isCopVerified": true,    "merchantId": "string",    "merchantReference": "string",    "provider": {      "code": "string",      "id": "string",      "logoUrl": "string",      "name": "string",      "status": "string"    },    "purpose": "string",    "redirectUrl": "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": "New",    "successRedirectUrl": "string",    "type": "SingleInstantPayment",    "updatedAt": "2025-01-01T00:00:00Z"  },  "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"}

Response Body

`application/json`

curl -X DELETE "https://example.com/payment-requests/string" \  -H "x-tenant: UAE"

Empty

{  "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": "string",  "details": {},  "message": "string"}

{  "code": "not_found",  "details": {},  "message": "string"}

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

503application/json

defaultapplication/json

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

409application/json

429application/json

500application/json

503application/json

defaultapplication/json

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

503application/json

defaultapplication/json

Response Body

200

400application/json

401application/json

403application/json

404application/json

409application/json

429application/json

500application/json

503application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`