Checkout Success
Checkout resource returned after a synchronous processing attempt. In addition to the base checkout fields, it can include the resulting transaction identifiers and any newly created payment instrument token.
Properties
| Name | Type | Description |
|---|---|---|
| transaction_code | string | Transaction code of the successful transaction with which the payment for the checkout is completed. |
| transaction_id | string | Transaction ID of the successful transaction with which the payment for the checkout is completed. |
| merchant_name | string | Name of the merchant |
| redirect_url | string | URL where the payer is redirected after a redirect-based payment or SCA flow completes. |
| payment_instrument | object | Details of the saved payment instrument created or reused during checkout processing. |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Checkout Success",
"description": "Checkout resource returned after a synchronous processing attempt. In addition to the base checkout fields, it can include the resulting transaction identifiers and any newly created payment instrument token.",
"allOf": [
{
"$ref": "#/components/schemas/Checkout"
},
{
"type": "object",
"properties": {
"transaction_code": {
"description": "Transaction code of the successful transaction with which the payment for the checkout is completed.",
"type": "string",
"example": "TEENSK4W2K",
"readOnly": true
},
"transaction_id": {
"description": "Transaction ID of the successful transaction with which the payment for the checkout is completed.",
"type": "string",
"example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4",
"readOnly": true
},
"merchant_name": {
"description": "Name of the merchant",
"type": "string",
"example": "Sample Merchant"
},
"redirect_url": {
"description": "URL where the payer is redirected after a redirect-based payment or SCA flow completes.",
"type": "string",
"example": "https://mysite.com/completed_purchase"
},
"payment_instrument": {
"description": "Details of the saved payment instrument created or reused during checkout processing.",
"type": "object",
"properties": {
"token": {
"description": "Token value",
"type": "string",
"example": "e76d7e5c-9375-4fac-a7e7-b19dc5302fbc"
}
}
}
}
}
]
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/checkoutsuccess"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.