Reference
List invoice payments
Lists the payments recorded against an invoice, newest first.
Lists the payments recorded against an invoice, newest first.
Authorization
bearerAuth payments:readAuthorizationBearer <token>
A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: payments:read
Path Parameters
id*string
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "data": [ { "id": "string", "invoice_id": "string", "method": "manual", "status": "pending", "amount_cents": -9007199254740991, "currency": "string", "processor_ref": "string", "received_at": "string", "note": "string", "created_at": "string", "updated_at": "string" } ], "next_cursor": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Delete a payment DELETE
Voids a recorded payment. The invoice's amount paid and status refresh automatically.
Arm or disarm installment auto-charge POST
Arms an installment to be charged off-session against a saved payment method on its due date (or disarms it with `method_id: null`). A decline is surfaced on the installment and can be retried by re-arming.