List an order's payments
Every payment attempt on the order (newest first) with its status, the gateway events that concern them (at most 100, newest first) and the refunds issued. Provider snapshots are sanitized; card data and secrets are never returned.
Poll this while a PIX charge is pending: an intent turning approved
means the order is paid.
Authorization
bearer_auth Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
Store id
uuidOrder id
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments"{
"events": [
{
"created_at": "2019-08-24T14:15:22Z",
"error_message": "string",
"event_type": "string",
"external_event_id": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"payload_json": {},
"processed_at": "2019-08-24T14:15:22Z",
"provider_code": "string",
"success": true
}
],
"intents": [
{
"amount_cents": 0,
"cart_id": "b5b98de2-0f5f-4a68-b8c7-2aa7bb7683bb",
"created_at": "2019-08-24T14:15:22Z",
"currency": "string",
"error_code": "string",
"error_message": "string",
"expires_at": "2019-08-24T14:15:22Z",
"external_id": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"installments": 0,
"method": "pix",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"payer_document": "string",
"provider_code": "string",
"provider_snapshot_json": {},
"status": "pending",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"refunds": [
{
"amount_cents": 0,
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"currency": "string",
"external_id": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe",
"payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",
"provider_code": "string",
"reason": "string"
}
]
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}