comecerodocs
Invoices

List invoice payments

GET
/invoices/{invoice_id}/payments

Returns the payments made against an invoice, including failed attempts. The list is offset-based. Takes a secret, trusted or limited token. A limited token must be bound to the invoice and cannot see a draft.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

invoice_id*string

The invoice id.

Query Parameters

limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
sort_by?string

The field to sort by. Defaults to date_created.

Value in"date_created""date_modified""date_completed"
status?string

Only payments with this status.

Value in"initiated""processing""pending""completed""failed""cancelled""refunded""retry"
reference?string

Only payments with this gateway reference.

expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

An offset-based list of payments.

application/json
  1. response

An offset-based list of the payments made against an invoice.

total_items?integer

The number of items in the whole list.

total_pages?integer

The number of pages.

current_page?integer

The page number of this page, starting at 1.

next_page_url?|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset?|

The offset of the next page, or null on the last page.

previous_page_url?|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset?|

The offset of the previous page, or null on the first page.

current_page_url?string

The URL of this page.

Formaturi
data?array<>

The items on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/invoices/string/payments'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639/payments?offset=0&limit=10",  "data": [    {      "object": "payment",      "url": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC",      "payment_id": "0090460891496PyrYzd9DC",      "account_id": "AB1234",      "success": true,      "status": "completed",      "date_created": "2026-11-07T19:25:02Z",      "date_modified": "2026-11-07T19:25:04Z",      "date_completed": "2026-11-07T19:25:04Z",      "test": true,      "currency": "USD",      "subtotal": 199.9,      "shipping": 0,      "tax": 14.99,      "total": 214.89,      "customer_ip_address": "203.0.113.44",      "customer_ip_country": "US",      "description": null,      "reference": null,      "merchant_descriptor": "EXAMPLE SHOP",      "merchant_contact": "shop.example.com",      "apply_to_balance": false,      "response_code": "OK",      "response_message": "OK",      "gateway_transaction_id": "test_ch_1029384756",      "gateway_error_code": null,      "gateway_error_message": null,      "risk_decline": false,      "gateway": "https://api.comecero.com/api/v1/gateways/0090100200300GwTest01",      "app_id": null,      "app_version": null,      "payment_method": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/payment_method",      "response_data": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/response_data",      "reporting_currency": "USD",      "reporting_subtotal": 199.9,      "reporting_shipping": 0,      "reporting_tax": 14.99,      "reporting_total": 214.89,      "reporting_fx_rate": 1,      "settlement_currency": "USD",      "settlement_subtotal": 199.9,      "settlement_shipping": 0,      "settlement_tax": 14.99,      "settlement_total": 214.89,      "fx_rate": 1,      "customer": "https://api.comecero.com/api/v1/customers/0091307952481CuXUhvCA1",      "order": "https://api.comecero.com/api/v1/orders/8352-CSGYX-348",      "cart": "https://api.comecero.com/api/v1/carts/0091307952465CafhFSTa1",      "invoice": null,      "refunds": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/refunds",      "fees": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/fees",      "fee_summary": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/fee_summary",      "commissions": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/commissions",      "failed_gateway_attempts": "https://api.comecero.com/api/v1/payments/0090460891496PyrYzd9DC/failed_gateway_attempts",      "meta": null    }  ]}

Get invoice payment options GET

Returns how the customer can pay this invoice: the payment methods and card types your gateways take in the invoice currency, shipping choices for the customer's country, and the customer fields still needed. Call it before you show a payment form. Takes a secret, trusted or limited token. A limited token must be bound to the invoice and cannot see a draft.

Pay an invoice POST

Charges a payment against a published, open invoice. Send a `payment_method` (or a saved `payment_method_id`). Do not send `currency`: it comes from the invoice. Leave out `total` to pay what is left. Send a smaller `total` to pay part of it; the total of all payments cannot pass the invoice total. Money moves. When the invoice is paid in full it closes, becomes an order with the same id, and `invoice:paid` fires. `invoice:payment_completed` fires, with `order:payment_completed`, when the completed payments cover the total and none is `pending`. Some payment methods (such as PayPal) return a payment that waits for the customer to approve it. Takes a secret, trusted or limited token. A limited token must be bound to the invoice, and a limited test token needs a user who may make test transactions.