API referenceInvoices

What has been paid against this invoice

Both sources in one list, newest first. "What paid this?" is one question, so it gets one answer. A business chasing a discrepancy should not have to know that an online payment is a charge and a bank transfer is not — though `source` says which, for anyone who does. Only settled, non-test payments appear, so the rows always add up to `paid_minor`. A pending charge has paid nothing yet, and listing it would create exactly the discrepancy this is meant to explain.

GET
/api/b/v1/invoices/{invoice_id}/payments

Both sources in one list, newest first.

"What paid this?" is one question, so it gets one answer. A business chasing a discrepancy should not have to know that an online payment is a charge and a bank transfer is not — though source says which, for anyone who does.

Only settled, non-test payments appear, so the rows always add up to paid_minor. A pending charge has paid nothing yet, and listing it would create exactly the discrepancy this is meant to explain.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

invoice_id*Invoice Id
Formatuuid
admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments"
{  "payments": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "source": "string",      "amount_minor": 450000,      "currency": "string",      "method": "string",      "reference": "string",      "received_at": "2019-08-24T14:15:22Z"    }  ],  "paid_minor": 450000,  "outstanding_minor": 0}