Developers

Payments

Markdown

Get a payment

A single payment outcome by its numeric ID. An attempt that is still in progress returns 404.

GET/stores/{storeId}/v1/payments/{id}

Path parameters

idstringrequired

Response

dataobjectrequired
idstringrequired
order_idstring | nullrequired
statusstringrequired
Payment outcome: succeeded or failed. In-progress attempts are not returned.succeeded failed
created_atstring (date-time)required
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
404RESOURCE_NOT_FOUNDThe ID does not exist in this store.
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