Get Invoice Payments

GET

/api/:account_id/invoices/:external_id/payments

Get all payments that contributed to paying an invoice. Returns a paginated list of payment allocations showing which payment intents paid this invoice and how much each contributed. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Authentication

AuthorizationBearer

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

Path parameters

external_idstringRequired

account_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Errors

422

Unprocessable Entity Error

1	{
2	"items": [
3	{
4	"payment_intent_id": "pi_3KJ9x2L8a9bX7YzQwR5t6uV1",
5	"amount_atom": 250000,
6	"total_amount_atom": 500000,
7	"refunded_amount_atom": 0,
8	"status": "succeeded",
9	"created_at": "2024-01-15T09:30:00Z",
10	"processor_attempt_id": "attempt_20240615_001",
11	"decline_reason": null,
12	"failure_code": null
13	}
14	],
15	"total": 1,
16	"has_more": false
17	}

$	curl https://app.paymentkit.com/api/account_id/invoices/external_id/payments \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"