--- updatedAt: 2026-03-04T18:58:43.000Z agentTools: siteIndex: https://docs.affirm.com/llms.txt projectIndex: https://docs.affirm.com/developers/llms.txt --- # Read Checkout Returns the checkout details. For the global Read endpoint, see the Read (Global) page. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Checkout API", "version": "2.0" }, "security": [ { "basicAuth": [] } ], "paths": { "/checkout/{checkout_id}": { "get": { "tags": [ "Checkout" ], "operationId": "read_checkout", "summary": "Read Checkout", "description": "Returns the checkout details.", "parameters": [ { "in": "path", "name": "checkout_id", "description": "A `checkout_token` that represents the purchase and customer information on purchase (e.g tokenization).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HTTP 200 OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ReadCheckout" } } } }, "400": { "description": "HTTP 400 Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorBadRequest" } } } }, "401": { "description": "HTTP 401 Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorUnauthorized" } } } }, "404": { "description": "HTTP 404 Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorNotFound" } } } } } } } }, "servers": [ { "url": "https://sandbox.affirm.com/api/v2" }, { "url": "https://api.affirm.com/api/v2" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "ErrorBadRequest": { "properties": { "message": { "description": "The error message.", "example": "Bad Request", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 400, "type": "integer" }, "type": { "description": "The error type.", "example": "BAD_REQUEST", "type": "string" }, "code": { "description": "The error type.", "example": "BAD_REQUEST", "type": "string" } } }, "ErrorNotFound": { "properties": { "message": { "description": "The error message.", "example": "Not Found", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 404, "type": "integer" }, "type": { "description": "The error type.", "example": "NOT_FOUND", "type": "string" }, "code": { "description": "The error type.", "example": "NOT_FOUND", "type": "string" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } }, "type": "object" }, "ErrorUnauthorized": { "properties": { "message": { "description": "The error message.", "example": "Unauthorized", "type": "string" }, "status_code": { "description": "The HTTP status code.", "example": 401, "type": "integer" }, "type": { "description": "The error type.", "example": "UNAUTHORIZED", "type": "string" }, "code": { "description": "The error type.", "example": "UNAUTHORIZED", "type": "string" }, "token": { "description": "The error response embedded in a JWT token", "type": "string" } }, "type": "object" }, "ReadCheckout": { "type": "object", "properties": { "billing_frequency": { "description": "The billing frequency for the loan.", "example": "monthly", "type": "string" }, "currency": { "description": "The local currency of the charge with its being a valid subset of the ISO 4217 currency code.", "example": "USD", "type": "string" }, "meta": { "type": "object", "description": "Additional checkout metadata.", "properties": { "release": { "description": "The release of the funds.", "type": "string" }, "user_timezone": { "description": "The user's timezone.", "example": "America/Los_Angeles", "type": "string" }, "_affirm_tracking_uuid": { "description": "A uuid used for Affirm tracking.", "example": "356a483a-86b2-4846-b6f2-70d37d95a78c", "type": "string" } } }, "total": { "description": "The total amount of the checkout, less any discounts applied. This determines the total amount charged to the user. All numerical values must be passed as integer USD cents.", "example": 49999, "type": "integer" }, "financial_program_external_name": { "description": "The external name of the financing program.", "type": "string" }, "financial_program_name": { "description": "The name of the financing program.", "example": "standard_3_6_12", "type": "string" }, "checkout_flow_type": { "description": "The type of checkout flow used by the customer.", "example": "classic", "type": "string" }, "billing": { "type": "object", "description": "The customer billing information.", "properties": { "name": { "type": "object", "properties": { "full": { "description": "The full name of the customer, which must contain at least two words." }, "last": { "description": "The last name of the customer.", "type": "string" }, "first": { "description": "The first name of the customer.", "type": "string" } } }, "phone_number": { "description": "The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters.", "example": "1234567890", "type": "string", "nullable": true }, "email": { "description": "The email address of the customer.", "example": "test@example.com", "type": "string", "nullable": true } } }, "shipping_amount": { "description": "The amount to ship the item.", "example": 400, "type": "integer" }, "config": { "description": "Needs description", "type": "string" }, "product_type": { "description": "The type of product for the purchase", "type": "string", "nullable": true }, "api_version": { "description": "The version of the API", "example": "v2", "type": "string" }, "metadata": { "type": "object", "description": "Metadata containing any additional data.", "properties": { "checkout_channel_type": { "description": "The type of channel for the checkout.", "example": "online", "type": "string" }, "mode": { "description": "The type of mode for the checkout.", "example": "redirect", "type": "string" } } }, "merchant": { "type": "object", "description": "A list of items specific to the merchant.", "properties": { "public_api_key": { "description": "The merchant's public api key.", "type": "string" }, "user_cancel_url": { "description": "On customer cancellation redirect them to this merchant URL.", "type": "string" }, "user_confirmation_url": { "description": "On customer confirmation redirect them to this merchant URL.", "type": "string" }, "user_confirmation_url_action": { "description": "Supported values -'GET' -'POST'", "type": "string" }, "name": { "required": [ "name" ], "description": "If you have multiple sites operating under a single Affirm account, you can override the external company/brand name that the customer sees. This affects all references to your company name in the Affirm UI.", "type": "string" }, "use_vcn": { "description": "A flag to enable virtual card integration (default is 'false').", "type": "boolean" } } }, "product": { "description": "The Affirm product.", "type": "string" }, "order_id": { "description": "Your internal order id. This is stored for your own reference.", "example": "ABC123", "type": "string" }, "suppress_expiration_declination_messaging": { "description": "Determines if the expiration declination messaging is surpressed.", "type": "boolean" }, "mfp_rule_input_data": { "type": "object", "description": "An item object containing data for multiple finance programs.", "properties": { "items": { "type": "object", "description": "An array of items based on the cart contents", "properties": { "sku_number": { "type": "object", "description": "The unique identifier (SKU) of the product.", "properties": { "sku": { "description": "The unique identifier (SKU) of the product.", "type": "integer" }, "item_url": { "description": "The item's product description page URL.", "type": "string" }, "display_name": { "description": "The display name of the product.", "type": "string" }, "unit_price": { "description": "The item individual price.", "type": "integer" }, "qty": { "description": "The item quantity expressed as an integer.", "type": "integer" }, "item_type": { "description": "The type of product in the cart.", "type": "string" }, "item_image_url": { "description": "The item's product image URL.", "type": "string" } } } } }, "total": { "description": "The total amount of the checkout, less any discounts applied. This determines the total amount charged to the user. All numerical values must be passed as integer USD cents.", "example": 49999, "type": "integer" }, "metadata": { "type": "object", "description": "Metadata containing any additional data.", "properties": { "checkout_channel_type": { "description": "The type of channel for the checkout.", "example": "online", "type": "string" }, "mode": { "description": "The type of mode for the checkout.", "example": "redirect", "type": "string" } } }, "financing_program": { "description": "A unique financing program name that is provided to you by Affirm. If you have a custom financing program available, you can enter the name of it in this field.", "type": "string" } } }, "loan_type": { "description": "The type of loan selected.", "example": "classic", "type": "string" }, "chekcout_type": { "description": "The type of checkout selected.", "example": "merchant", "type": "string" }, "tax_amount": { "description": "The total tax amount computed after all discounts have been applied. Defaults to 0.", "type": "integer" }, "checkout_status": { "description": "The status of the checkout.", "type": "string" }, "shipping": { "description": "The shipping information. Required for scenarios where goods are shipped.", "type": "object", "properties": { "name": { "type": "object", "properties": { "full": { "description": "The customer's name.", "example": "John Doe", "type": "string" }, "first": { "description": "The customer's first name.", "example": "John", "type": "string" }, "last": { "description": "The customer's last name.", "example": "Doe", "type": "string" } } }, "address": { "type": "object", "properties": { "city": { "description": "The name of the city.", "example": "San Francisco", "type": "string" }, "country": { "description": "The abbreviated name of the country.", "example": "USA", "type": "string" }, "line1": { "description": "A U.S. street address.", "example": "123 Example Street", "type": "string" }, "line2": { "description": "The apartment number, floor or suite that complements the street address.", "example": "Apt 123", "type": "string" }, "state": { "description": "The 2-letter postal abbreviation or full name of the U.S. state.", "example": "CA", "type": "string" }, "zipcode": { "description": "The 5-digit postal code of the address.", "example": "94107", "type": "string" } } }, "email": { "description": "The email address of the customer.", "example": "test@example.com", "type": "string", "nullable": true }, "phone_number": { "description": "The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters.", "example": "1234567890", "type": "string", "nullable": true } } }, "use_adaptive": { "description": "Determines if the product is using Adaptive Checkout", "type": "boolean" }, "financing_program": { "description": "The applicable Affirm financing program", "type": "string" }, "merchant_external_reference": { "description": "A unique identifier that can be used to link to a merchant's internal systems, (ie - cart ID or order ID).", "example": "ab-12345", "type": "string" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ``` # Sibling pages * [Store](https://docs.affirm.com/developers/reference/store-1.md) * [Direct](https://docs.affirm.com/developers/reference/direct-1.md) * [Update Checkout](https://docs.affirm.com/developers/reference/update_checkout-1.md) * [Resend Checkout](https://docs.affirm.com/developers/reference/resend_checkout-1.md)