comecerodocs
Payments

List payment refunds

GET
/payments/{payment_id}/refunds

Lists the refunds and chargebacks of a payment. An offset-based list. sort_by takes date_created (the default), date_modified or date_completed. Any token type may call it; a limited token only for a payment it is bound to.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

payment_id*string

The id of the payment.

Query Parameters

status?string

Only refunds with this status, for example completed, pending or failed.

is_chargeback?boolean

true for chargebacks only, false for refunds only.

reference?string

Only refunds with this reference.

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
sort_by?string

The field to sort by.

Default"date_created"
Value in"date_created""date_modified""date_completed"
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
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

The refunds of the payment.

application/json
  1. response

An offset-based list of the refunds of a payment.

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 refunds on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/payments/string/refunds'
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/payments/0090460891496PyrYzd9DC/refunds?offset=0&limit=10",  "data": [    {      "object": "refund",      "url": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5",      "refund_id": "0090374314462Rec3PffZ5",      "account_id": "AB1234",      "success": true,      "status": "completed",      "reference": null,      "date_created": "2026-11-03T10:12:40Z",      "date_modified": "2026-11-03T10:12:41Z",      "date_completed": "2026-11-03T10:12:41Z",      "test": true,      "currency": "USD",      "subtotal": 49.95,      "shipping": 0,      "tax": 0,      "total": 49.95,      "reason": "Customer request",      "apply_to_balance": false,      "is_chargeback": false,      "record_only": false,      "record_only_memo": null,      "response_code": "OK",      "response_message": "OK",      "gateway_transaction_id": "re_test_3PffZ5",      "gateway_error_code": null,      "gateway_error_message": null,      "gateway": "https://api.comecero.com/api/v1/gateways/0089584408915Gtf5AsdJ8",      "comments": null,      "payment_method": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/payment_method",      "settlement_currency": "USD",      "settlement_subtotal": 49.95,      "settlement_shipping": 0,      "settlement_tax": 0,      "settlement_total": 49.95,      "fx_rate": 1,      "reporting_currency": "USD",      "reporting_subtotal": 49.95,      "reporting_shipping": 0,      "reporting_tax": 0,      "reporting_total": 49.95,      "reporting_fx_rate": 1,      "items": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/items",      "customer": "https://api.comecero.com/api/v1/customers/0093717976099CuAiEBXu4",      "order": "https://api.comecero.com/api/v1/orders/7393-GMRFY-954",      "payment": "https://api.comecero.com/api/v1/payments/0093717991362PyRYN1qc6",      "invoice": null,      "fees": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/fees",      "fee_summary": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/fee_summary",      "commissions": "https://api.comecero.com/api/v1/refunds/0090374314462Rec3PffZ5/commissions",      "meta": null    }  ]}

Retrieve a payment's payment method GET

Returns the payment method used for the payment, with card details masked. Any token type may call it; a limited token only for a payment it is bound to.

Refund a payment POST

Gives money back on a captured payment, in full or in part. Money moves back to the shopper's payment method and refund events fire. Secret and trusted tokens that may create refunds only; a limited token gets `403`.