Get checkout
get_checkoutRead-only
Retrieve checkout details by ID for owner view. Requires merchant read scope.
Instructions
Fetch a checkout by id (owner view). Requires scope merchant_read.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| checkout_id | Yes | Checkout id (chk_…). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| amount | Yes | ||
| status | Yes | ||
| is_live | Yes | ||
| metadata | Yes | Merchant metadata, parsed to an object when it was valid JSON. | |
| image_url | Yes | ||
| created_at | Yes | ||
| expires_at | Yes | ||
| approved_at | Yes | ||
| description | Yes | ||
| pix_payload | Yes | PIX payload; present only while pending. | |
| callback_url | Yes | ||
| cancelled_at | Yes | ||
| completed_at | Yes | ||
| redirect_url | Yes | ||
| processing_at | Yes | ||
| blockchain_tx_id | Yes | ||
| rejection_reasons | Yes | Provider reason codes when the underlying payment was refused/held; [] otherwise. |