List Payments | Redpin | Documentation

import requests
url = "https://sandbox.currenciesdirect.com/v3/customers/cust_123456789/payments"
querystring = {"page":"1","limit":"20"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "meta_data": {
    "next_page": "/v3/customers/cust_123456789/payments?page=2&limit=5",
    "total_records": 38,
    "total_pages": 8
  },
  "payments": [
    {
      "payment_id": "5636191",
      "instruction_number": "cust_123456789-000000009",
      "status": "AWAITING_FUNDS",
      "payouts": [
        {
          "amount": {
            "currency": "AED",
            "value": 107.56
          },
          "recipient_details": {
            "recipient_id": "rec_123456789",
            "payment_reference": "payment to Mashreq account1"
          },
          "status": "NOT_STARTED",
          "payment_date": "2025-07-10"
        },
        {
          "amount": {
            "currency": "AED",
            "value": 100
          },
          "recipient_details": {
            "recipient_id": "rec_987654321",
            "payment_reference": "payment to Mashreq account2"
          },
          "status": "NOT_STARTED",
          "payment_date": "2025-07-10"
        }
      ],
      "client_reference_id": "c2860379-c845-4f4e-9d2e-5b058e9114b9",
      "fx_conversion": {
        "selling_amount": {
          "currency": "GBP",
          "value": 43.24
        },
        "buying_amount": {
          "currency": "AED",
          "value": 207.56
        },
        "agreed_rate": 4.8794,
        "booking_datetime": "2025-07-07T13:02:46Z",
        "value_date": "2025-07-09",
        "status": "OPEN"
      }
    }
  ]
}

Retrieve a paginated list of all payments for a given customer.

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired

Unique identifier for the customer whose payments are being retrieved.

Query parameters

pageintegerOptional>=1

Page number for pagination. Default is 1

limitintegerOptional1-100

Number of items per page. Default is 20, max is 100

Response

Successful response with paginated list of payments

meta_dataobject

paymentslist of objects

Authentication

Path parameters

Query parameters

Response

Errors