Checkouts
Get a checkout
Retrieve a payment checkout session.
get/v2/checkouts/{checkout_id}
Request
- Base URLhttps://api.getpaid.io
- Auth
- OAuth 2Client credentialsToken URLhttps://auth.getpaid.io/oauth/tokenScopespayments:read
- or OAuth 2Client credentialsToken URLhttps://auth.getpaid.io/oauth/tokenScopespayments:read_write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
checkout_idstring id required
The unique identifier of the checkout.
Example:cko_4kf9v6xp00hzc99rdwr5m97wce
Response
OK
Example response
{
"id": "cko_4kf9v6xp00hzc99rdwr5m97wce",
"reference": "ORD-202510-0232",
"created_at": "2025-09-01T22:05:48.479Z",
"updated_at": "2025-09-01T22:05:48.479Z",
"expires_at": "2025-09-01T22:05:48.479Z",
"amount": 1000,
"currency": "EUR",
"description": "Order 202510-0232",
"payment_methods": {
"options": {
"cards": {
"dynamic_descriptor": "TITAN*202510-0232"
},
"sepa_direct_debit": {
"remittance_info": "Titan Auto Parts Ord. #0232 Inv. #202500632"
}
}
},
"splits": {
"accounts": [
{
"id": "acc_44678r08jtm8zbt227tzhc4nw5",
"version": "2",
"split": {
"amount": 1000
},
"processing_fee": {
"percentage": 100
}
}
]
},
"payments": [
{
"id": "pay_4a4m2pjycdb1jbj68h1rvk9kcz",
"created_at": "2025-09-01T22:05:48.479Z",
"updated_at": "2025-09-01T22:05:48.479Z"
}
],
"theme": {
"id": "thm_4jkgtzffbf9pzem7dgfhdeztwa"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.