AFaffirm
Checkout

Read Checkout

Returns the checkout details.

get/checkout/{checkout_id}

Request

  • Base URL
    https://sandbox.affirm.com/api/v2
  • URL
    https://sandbox.affirm.com/api/v2/checkout/{checkout_id}
  • Auth
    HTTP basic

Path parameters

checkout_idstring required

A checkout_token that represents the purchase and customer information on purchase (e.g tokenization).

Response

HTTP 200 OK

billing_frequencystring

The billing frequency for the loan.

currencystring

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

totalinteger

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_namestring

The external name of the financing program.

financial_program_namestring

The name of the financing program.

checkout_flow_typestring

The type of checkout flow used by the customer.

shipping_amountinteger

The amount to ship the item.

configstring

Needs description

product_typestring nullable

The type of product for the purchase

api_versionstring

The version of the API

productstring

The Affirm product.

order_idstring

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

suppress_expiration_declination_messagingboolean

Determines if the expiration declination messaging is surpressed.

loan_typestring

The type of loan selected.

chekcout_typestring

The type of checkout selected.

tax_amountinteger

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

checkout_statusstring

The status of the checkout.

use_adaptiveboolean

Determines if the product is using Adaptive Checkout

financing_programstring

The applicable Affirm financing program

merchant_external_referencestring

A unique identifier that can be used to link to a merchant's internal systems, (ie - cart ID or order ID).

Example response

{
  "billing_frequency": "monthly",
  "currency": "USD",
  "meta": {
    "user_timezone": "America/Los_Angeles",
    "_affirm_tracking_uuid": "356a483a-86b2-4846-b6f2-70d37d95a78c"
  },
  "total": 49999,
  "financial_program_name": "standard_3_6_12",
  "checkout_flow_type": "classic",
  "billing": {
    "phone_number": "1234567890",
    "email": "test@example.com"
  },
  "shipping_amount": 400,
  "api_version": "v2",
  "metadata": {
    "checkout_channel_type": "online",
    "mode": "redirect"
  },
  "order_id": "ABC123",
  "mfp_rule_input_data": {
    "total": 49999,
    "metadata": {
      "checkout_channel_type": "online",
      "mode": "redirect"
    }
  },
  "loan_type": "classic",
  "chekcout_type": "merchant",
  "shipping": {
    "name": {
      "full": "John Doe",
      "first": "John",
      "last": "Doe"
    },
    "address": {
      "city": "San Francisco",
      "country": "USA",
      "line1": "123 Example Street",
      "line2": "Apt 123",
      "state": "CA",
      "zipcode": "94107"
    },
    "email": "test@example.com",
    "phone_number": "1234567890"
  },
  "merchant_external_reference": "ab-12345"
}

Changes

No recorded changes to this operation across all 1 revision of this API.