List payments

GET

https://api.agentpaid.io/api/v2/payments/

GET

/api/v2/payments/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.payments.listPayments({});
8 }
9 main();

1 {
2   "data": [
3     {
4       "id": "pay_9f8e7d6c",
5       "number": 102,
6       "customerId": "cus_4a7b9c2d",
7       "invoiceId": "inv_5d3f2a1b",
8       "orderId": "ord_7c8e9f0a",
9       "amount": 25000,
10       "allocatedAmount": 20000,
11       "balance": 5000,
12       "currency": "USD",
13       "paymentDate": "2024-04-10T14:45:00Z",
14       "paymentType": "creditCard",
15       "status": "posted",
16       "metadata": {
17         "transactionId": "txn_7890abcd",
18         "notes": "Payment received via Visa"
19       },
20       "createdAt": "2024-04-10T14:45:00Z",
21       "updatedAt": "2024-04-11T10:00:00Z"
22     }
23   ],
24   "pagination": {
25     "limit": 10,
26     "offset": 0,
27     "total": 125,
28     "hasMore": true
29   }
30 }

Lists payments for your organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional>=0

customerIdstringOptional>=1 character

Filter by Paid customer ID.

externalCustomerIdstringOptional>=1 character

Filter by your external customer ID.

statusenumOptional

Filter by payment status.

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error