Retrieve a payment list
Returns a group of payments acted on together, such as the captures or voids made when you capture or void an order. Secret and trusted tokens only; a limited token gets 403. An unknown id returns an empty list, not 404.
AuthorizationBearer <token>A secret, trusted or limited token. See Authentication.
payment_list_id*stringThe id of the payment list.
expand?stringComma-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?stringComma-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?stringComma-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.
The payment list.
application/json- response
A group of payments acted on together, such as the captures or voids made when you capture or void an order with more than one payment. Not a page of a list: it has no paging.
object*"payment_list"The object type. Always payment_list.
"payment_list"url*stringThe full URL of the payment list.
uripayment_list_id*stringThe id of the payment list.
test*booleanTrue for test payments. False when the list is empty.
account_id*|The account of the payments. Null when the list is empty.
currency*|The currency of the first payment. Null when the list is empty.
subtotal*numberThe sum of subtotal of the pending and completed payments.
shipping*numberThe sum of shipping of the pending and completed payments.
tax*numberThe sum of tax of the pending and completed payments.
total*numberThe sum of total of the pending and completed payments.
success_count*integerHow many payments have success true.
failure_count*integerHow many payments have success false.
payments*array<>The payments.
curl -X GET 'https://api.comecero.com/api/v1/payment_list/string'{ "object": "payment_list", "url": "https://api.comecero.com/api/v1/payment_list/0091310055812aB3kQ9", "payment_list_id": "0091310055812aB3kQ9", "test": true, "account_id": "AB1234", "currency": "USD", "subtotal": 199.9, "shipping": 0, "tax": 14.99, "total": 214.89, "success_count": 1, "failure_count": 0, "payments": []}Overview
Previous Page
List all payments GET
Lists the payments of your account, failed ones included. A cursor-based list: page with `after_item` and `before_item`. It has no `sort_by`. Secret and trusted tokens only; a limited token gets `403`. Inside the list, `refunds`, `fees`, `commissions` and `failed_gateway_attempts` are always URLs.