Developers

Payments

Markdown

List payments

Payment outcomes: succeeded or failed, with the order ID. In-progress attempts are not returned.

GET/stores/{storeId}/v1/payments

Each payment has exactly id, order_id, status and created_at. There is no gateway, amount, currency or card data. A later refund appears on the order as payment_status: refunded.

Query parameters

limitinteger = 25
Number of items per page.
cursorstring
The meta.next_cursor value from the previous page. Valid for 15 minutes and bound to the same filters.

Response

dataarray<object>required
idstringrequired
order_idstring | nullrequired
statusstringrequired
Payment outcome: succeeded or failed. In-progress attempts are not returned.succeeded failed
created_atstring (date-time)required
metaobjectrequired
next_cursorstring | null
Cursor for the next page, or null on the last page.
request_idstring (uuid)

Errors

HTTPCodeMeaning
403SCOPE_REQUIREDThe token does not carry the required scope.
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close