comecerodocs

List payment notifications

GET
/payments/{payment_id}/notifications

Lists the emails and other notifications sent for a payment, such as the receipt. An offset-based list. sort_by takes date_created (the default) or date_modified. 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

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"
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
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 notifications for the payment.

application/json
  1. response

An offset-based list of the notifications sent for 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 notifications on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/payments/string/notifications'
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/notifications?offset=0&limit=10",  "data": [    {      "object": "notification",      "url": "https://api.comecero.com/api/v1/notifications/1102611073905NOq2Lx7Pv",      "notification_id": "1102611073905NOq2Lx7Pv",      "test": true,      "account_id": "AB1234",      "type": "order:confirmation",      "method": "email",      "from": "notification@comecero.com",      "from_name": "Example Shop",      "reply_to": "support@example.com",      "bcc": null,      "destination": "john@example.com",      "subject": "Your Order Confirmation",      "notification_subscription": "https://api.comecero.com/api/v1/notification_subscriptions/1102500112233NSd4Kw9Tz",      "customer": "https://api.comecero.com/api/v1/customers/1102611073801CUa8Hn2Lq",      "status": "delivered",      "date_created": "2026-11-07T14:32:12Z",      "date_modified": "2026-11-07T14:32:14Z",      "data": {        "order": {          "order_id": "7393-GMRFY-954",          "total": 99.95,          "currency": "USD"        }      },      "body": "<html><body><h1>Thanks for your order</h1></body></html>"    }  ]}