Read Checkout

get https://api.affirm.com/api/v2/checkout/{checkout_id}

Returns the checkout details.

Responses

Response body

object

billing_frequency

string

The billing frequency for the loan.

currency

string

The local currency of the charge with its being a valid subset of the ISO 4217 currency code.

meta

object

Additional checkout metadata.

release

string

The release of the funds.

user_timezone

string

The user's timezone.

_affirm_tracking_uuid

string

A uuid used for Affirm tracking.

total

integer

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.

financial_program_external_name

string

The external name of the financing program.

financial_program_name

string

The name of the financing program.

checkout_flow_type

string

The type of checkout flow used by the customer.

billing

object

The customer billing information.

name

object

shipping_amount

integer

The amount to ship the item.

config

string

Needs description

product_type

string | null

The type of product for the purchase

api_version

string

The version of the API

metadata

object

Metadata containing any additional data.

checkout_channel_type

string

The type of channel for the checkout.

mode

string

The type of mode for the checkout.

merchant

object

A list of items specific to the merchant.

public_api_key

string

The merchant's public api key.

user_cancel_url

string

On customer cancellation redirect them to this merchant URL.

user_confirmation_url

string

On customer confirmation redirect them to this merchant URL.

name

string

Redirects the customer tp this merchant URL upon cancellation.

product

string

The Affirm product.

order_id

string

Your internal order id. This is stored for your own reference.

suppress_expiration_declination_messaging

boolean

Determines if the expiration declination messaging is surpressed.

mfp_rule_input_data

object

An item object containing data for multiple finance programs.

items

object

An array of items based on the cart contents

total

integer

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.

metadata

object

Metadata containing any additional data.

financing_program

string

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.

loan_type

string

The type of loan selected.

chekcout_type

string

The type of checkout selected.

tax_amount

integer

The total tax amount computed after all discounts have been applied. Defaults to 0.

checkout_status

string

The status of the checkout.

shipping

object

name

object

address

object

use_adaptive

boolean

Determines if the product is using Adaptive Checkout

financing_program

string

The applicable Affirm financing program

merchant_external_reference

integer

The total amount in cents of the purchase.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.affirm.com/api/v2/checkout/checkout_id \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200HTTP 200 OK

400HTTP 400 Bad Request

401HTTP 401 Unauthorized

404HTTP 404 Not Found