v1

latestOpenAPI 3.1.02026-07-136388308.2 KB

Open Banking

Get a list of payment request transactions

This endpoint will retrieve the list of open banking payment requests made on your account. You will need to enable PERM_BUSINESS_GET_PAYMENT_REQUEST_TRANSACTIONS to use this endpoint.

get/v2/paymentrequests/sent

Response

The list of payment requests sent

totalinteger

The total number of payment request payments in the list.

dateRangeTointeger

Date Range

Example response

{
  "total": 3,
  "dateRangeTo": 1726571260003,
  "paymentRequests": [
    {
      "accountName": "Euro Account",
      "code": "1234abcd",
      "currency": "EUR",
      "dateCreated": "2024-09-12T14:55:03.857Z",
      "description": "FIRE/John Doe",
      "direction": "SENT",
      "icanTo": 66204,
      "maxNumberPayments": 1,
      "myRef": "Terminal",
      "orderDetails": {
        "merchantNumber": "1234567",
        "orderId": "6c28a47d-4502-4111",
        "productId": "ZFDAA-1221",
        "customerNumber": "123645",
        "variableReference": "John Doe",
        "comment1": "Additional comments about the transaction",
        "comment2": "Additional comments about the transaction",
        "merchantCustomerIdentification": "CustNum-303863544",
        "deliveryAddressLine1": "12 The Street",
        "deliveryAddressLine2": "The Way",
        "deliveryCity": "London",
        "deliveryPostCode": "EC15155",
        "deliveryCountry": "GB"
      }
    }
  ]
}