For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API GuideAPI ReferenceChangelog
API GuideAPI ReferenceChangelog
  • API Reference
      • API Integration
        • Legacy APIs
            • POSTMake a Payment
            • GETReview Payments
            • GETView a Payment
  • Webhook Reference
LogoLogo
API ReferenceCustomersAPI IntegrationLegacy APIsLegacy Payments

Review Payments

GET
/v1/customers/:customer_id/payments
GET
/v1/customers/:customer_id/payments
$curl -G https://sandbox.currenciesdirect.com/v1/customers/cust_123456789/payments \
>     -H "Authorization: Bearer <token>" \
>     -d page=1 \
>     -d limit=50 \
>     -d currency=USD \
>     -d from=2019-01-01 \
>     -d to=2019-12-31 \
>     -d paymentstatus=INPROCESS
1{
2  "payments": [
3    {
4      "payment_id": "2932478",
5      "instruction_number": "0202000005924291-000000164",
6      "currency_code": "USD",
7      "amount": 10,
8      "recipient_details": {
9        "recipient_name": "Joe Bloggs",
10        "recipient_account_number": "457037479121",
11        "country_code": "USA"
12      },
13      "status": "INPROCESS",
14      "payment_reference": "987564823645",
15      "created_datetime": "2019-05-20T16:42:12Z",
16      "payment_date": "2019-05-20",
17      "client_reference_id": "987564823645"
18    },
19    {
20      "payment_id": "2932470",
21      "instruction_number": "0202000005924291-000000162",
22      "currency_code": "USD",
23      "amount": 10,
24      "recipient_details": {
25        "recipient_name": "Joe Bloggs",
26        "recipient_account_number": "457037479121",
27        "country_code": "USA"
28      },
29      "status": "INPROCESS",
30      "payment_reference": "987564823645",
31      "created_datetime": "2019-05-20T14:07:12Z",
32      "payment_date": "2019-05-20",
33      "client_reference_id": "987564823646"
34    },
35    {
36      "payment_id": "2932232",
37      "instruction_number": "0202000005924291-000000161",
38      "currency_code": "USD",
39      "amount": 1.91,
40      "recipient_details": {
41        "recipient_name": "Joe Bloggs",
42        "recipient_account_number": "457037479121",
43        "country_code": "USA"
44      },
45      "status": "INPROCESS",
46      "payment_reference": "saving 22",
47      "created_datetime": "2019-05-20T12:27:12Z",
48      "payment_date": "2019-05-20",
49      "client_reference_id": "987564823647"
50    },
51    {
52      "payment_id": "2932072",
53      "instruction_number": "0202000005924291-000000160",
54      "currency_code": "USD",
55      "amount": 1.91,
56      "recipient_details": {
57        "recipient_name": "Joe Bloggs",
58        "recipient_account_number": "457037479121",
59        "country_code": "USA"
60      },
61      "status": "INPROCESS",
62      "payment_reference": "saving 22",
63      "created_datetime": "2019-05-20T11:12:48Z",
64      "payment_date": "2019-05-20",
65      "client_reference_id": "987564823648"
66    },
67    {
68      "payment_id": "2907561",
69      "instruction_number": "0202000005924291-000000065",
70      "currency_code": "GBP",
71      "amount": 24.59,
72      "recipient_details": {
73        "recipient_name": "James NJJJ",
74        "recipient_account_number": "15487623",
75        "country_code": "GBR"
76      },
77      "status": "CANCELLED",
78      "payment_reference": "",
79      "created_datetime": "2019-01-21T15:14:18Z",
80      "payment_date": "2019-01-21",
81      "client_reference_id": "987564823649"
82    }
83  ],
84  "meta_data": {
85    "total_pages": "8",
86    "total_records": "38",
87    "next_page": "/v1/customers/0202000005924291/payments?page=2&limit=5"
88  }
89}
<Warning> **Deprecated**: This endpoint is deprecated. Please use [List Payments](/api-reference/customers/api-integration/payments/list-payments) (v3) instead. </Warning> Review all your Payments. **Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)
Was this page helpful?
Previous

View a Payment

Next
Built with

Deprecated: This endpoint is deprecated. Please use List Payments (v3) instead.

Review all your Payments.

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 Customer Identifier

Query parameters

pageintegerOptional>=1
For queries that return arrays of data. Including this optional query parameter causes the set of results to be paginated by this number of pages.
limitintegerOptional>=1
For queries that return arrays of data. Adding this optional query parameter causes the set of results to be split into pages of this size. Default is 50.
currencystringOptional
Adding this optional parameter will retrieve only payments including this buy currency.
fromdateOptional
Adding this optional query parameter will retrieve only payments made after or on this date.
todateOptional
Adding this optional query parameter will retrieve only payments made before or on this date.
paymentstatusenumOptional
Adding this optional query parameter will retrieve only payments having this status.
Allowed values:

Response

Ok. The response will contain a list of Payment Instructions.
paymentslist of objects
Array of Payment instructions.
meta_dataobject
Container for metadata.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error