GET
/
v1
/
payments
/
requests
List payment requests
curl --request GET \
  --url https://api.next.orenda.finance/v1/payments/requests \
  --header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/v1/payments/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
import requests

url = "https://api.next.orenda.finance/v1/payments/requests"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "data": [
    {
      "id": "fb2ce71e-fce7-44a0-a677-c7d69c3e40ab",
      "providerRequestId": "5723116",
      "amount": 60,
      "currency": "EUR",
      "customerId": "eefb4f93-9fb2-46ea-b7a3-be5676768cbe",
      "accountId": "64c646e9-4966-4ff1-aebd-a523336eb438",
      "programId": "orendamonovate",
      "type": "CUSTOMER",
      "subType": "SEND",
      "status": "PENDING_TM",
      "transactionMonitoring": "REJECTING",
      "statusHistory": [
        {
          "dateTime": "2024-09-24T15:20:15.193Z",
          "status": "PENDING"
        }
      ],
      "createdDateTime": "2024-09-24T15:20:15.193Z"
    }
  ],
  "total": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
programId
string
required

The program the request is scoped to. Required on every endpoint.

​
customerId
string

Filter to a single customer.

​
accountId
string

Filter to a single account.

​
status
string

Filter by payment-request status (e.g. FAILED). Omit to return the actionable pending queue.

Example:

"FAILED"

​
page
integer
default:1

1-based page number.

Required range: x >= 1
​
limit
integer
default:10

Page size.

Required range: x >= 1

Response

A page of payment requests.

Envelope for a page of payment requests. Note: this endpoint does not use the { success, result } wrapper.

​
data
object[]
required

Payment requests for the requested page.

​
total
integer
required

Total number of payment requests matching the filter, across all pages.

Example:

42