The checkout event object

Events are our way of letting you know when something interesting happens during the user journey at checkout. When an interesting event occurs, we create a new event object.

🚧

Webhooks can only be configured and approved by Affirm. You can contact Affirm at any time via the support widget.

Attributes

Attribute

Data type

Description

checkout_token

string

The checkout_id token.

event

enum

Type of events:

  • approved
  • confirmed
  • not_approved
  • opened
  • sent

event_timestamp

timestamp

The creation date of that event.

created

timestamp

The creation date of the checkout.

order_id

string

Only included if merchant passes the value in the checkout object.

webhook_session_id

string

Only included if merchant passes the value in the checkout object or Affirm.js

amount_financed

integer

The total amount financed in cents.

apr

integer

The APR with hundredths precision as an integer; multiply by 1000 to determine the APR with two decimal places.

downpayment_amount

integer

The total loan amount of the down payment in cents.

email_address

string

The email of the user.

finance_charge

integer

The total interest expressed in cents.

first_name

string

The first name of the user.

first_payment_date

timestamp

The loan first payment date.

has_downpayment

boolean

A downpayment flag.

last_name

string

The last name of the user.

number_of_payments

integer

The number of installments.

total

string

Total loan value at origination in cents.

{
amount_financed=100000&
apr=0.00&
checkout_token=JVIGTPXUKYT7NY4H&
created=2020-01-24T21%3A42%3A23.849774&
downpayment_amount=0&
email_address=joedoe%40123fakestreet.com&
event=confirmed&
event_timestamp=2020-01-24T21%3A42%3A41.110873&
finance_charge=0&
first_name=Joe&
first_payment_date=2020-02-23T23%3A59%3A59Z&
has_downpayment=False&
last_name=Sabou&
number_of_payments=3&
order_id=JKLMO4321&
total=100000
}