Switching to the Transactions API
Affirm has moved to the new Transactions API. While we will continue to support Charges API, we recommend using Transactions API. Transactions APIs support Leases serviced by LTO providers (Snap, Katapult, etc.) in addition to processing payments financed by installment loans. You can find more information here.
Attributes
| Attribute | Data type | Description |
|---|---|---|
| currency | string | Three-letter ISO currency code, in uppercase. Possible values: USD CAD |
| id | string | Unique identifier for the object (or commonly referred as the loan id or charge id). |
| under_dispute | boolean | Whether the loan has been disputed. |
| user_id | string | ID of the customers this loan is for. |
| platform | string | TBD |
| details | object | See details reference. |
| refundable | boolean | Whether the loan has been fully refunded. If the loan is only partially refunded, this attribute will still be true. |
| charge_event_count | integer | TBD |
| events | Array | An Array of events reference |
| pending | boolean | TBD |
| merchant_external_reference | string | Unique identifier for the object (or commonly referred as the loan id) set by the merchant. |
| status | string | The status of the loan is either authorized, captured, etc. Possible values: - opened - authorized - captured - disputed - refunded |
| order_id | string | Unique identifier for the object (or commonly referred as the loan id) set by the merchant. TBD - duplicate |
| void | boolean | Whether the charge has been voided. |
| expires | timestamp | TBD |
| payable | integer | TBD |
| merchant_id | string | Unique identifier for the merchant. |
| auth_hold | integer | Equals the amount in the loan that doesn't include the downpayment. Typically, the auth_hold and amount equal the same total, though in downpayment scenarios that can be different. |
| refunded_amount | integer | TBD |
| created | timestamp | TBD |
| is_instore | boolean | Whether the charge has been in-store. |
| amount | integer | Amount intended to be charged by this loan. A positive integer representing how much, in USD or CAD cents, to charge (e.g., 100 cents to charge $1.00). |
| is_marqeta_charge | boolean | TBD |
| balance | integer | Net amount of the loan, in cents. |
| financing_program | string | TBD |
{
"currency":"USD",
"id":"45XB-SLE0",
"under_dispute":false,
"user_id":"9594-2736-VATK",
"platform":null,
"details":{
"merchant":{
"public_api_key":"P1FHP4C9V3ZGSE0Z",
"user_cancel_url":"https://www.affirm.com/checkout.html?error=true",
"user_confirmation_url":"https://www.affirm.com/bin/checkout/authorize?locale=en_us&termAndCondition=true&keepMeUpdated=false",
"name":"redacted"
},
"financing_program_external_name":"b2.99_3z6z12r",
"financing_program_name":"b2.99_3z6z12r_exp93_op93_cut96_flatrate",
"checkout_flow_type":"classic",
"checkout_type":"merchant",
"billing":{
"name":{
"full": "John Doe"
},
"address":{
"line1": "325 Pacific Ave",
"city": "San Francisco",
"state": "CA",
"zipcode": "94112",
"country": "USA"
},
"phone_number": "4154443333",
"email": "[email protected]"
},
"items":{
"970071-01":{
"sku":"970071-01",
"item_url":"/support/journey/spare-details.970071-01.html",
"display_name":"Deep Clean Kit",
"unit_price":0,
"qty":1,
"item_type":"physical",
"item_image_url":""
},
"260042-01":{
"sku":"260042-01",
"item_url":"/sticks/affirm-v11-drive.html",
"display_name":"Affirm V11 Drive",
"unit_price":49999,
"qty":1,
"item_type":"physical",
"item_image_url":"https://www.affirm.com/products/primary/260042-01.png"
}
},
"shipping":{
"name":{
"full": "John Doe"
},
"address":{
"line1": "325 Pacific Ave",
"city": "San Francisco",
"state": "CA",
"zipcode": "94112",
"country": "USA"
},
"phone_number": "4154443333",
"email": "[email protected]"
},
"currency":"USD",
"mfp_rule_input_data":{
"items":{
"970071-01":{
"sku":"970071-01",
"item_url":"/support/journey/spare-details.970071-01.html",
"display_name":"Deep Clean Kit",
"unit_price":0,
"qty":1,
"item_type":"physical",
"item_image_url":""
},
"260042-01":{
"sku":"260042-01",
"item_url":"/sticks/affirm-v11-drive.html",
"display_name":"Affirm V11 Drive",
"unit_price":49999,
"qty":1,
"item_type":"physical",
"item_image_url":"https://www.affirm.com/products/primary/260042-01.png"
}
},
"total":54436,
"metadata":{
"checkout_channel_type":"online",
"mode":"modal"
}
},
"meta":{
"release":"false",
"user_timezone":"America/New_York",
"__affirm_tracking_uuid":"729b602b-9c1e-4354-86dc-85a61c834034"
},
"shipping_amount":0,
"tax_amount":4437,
"loan_type":"classic",
"total":54436,
"config":{
},
"api_version":"v2",
"metadata":{
"checkout_channel_type":"online",
"mode":"modal"
}
},
"refundable":false,
"charge_event_count":0,
"events":[
{
"created":"2020-01-21T23:27:51Z",
"currency":"USD",
"amount":"redacted",
"type":"auth",
"id":"EUNE6QDXW1DX4WAI",
"transaction_id":"ivSa9ksu0WGdhRF2"
}
],
"pending":true,
"merchant_external_reference":"ec7cf4f7-c250-415b-8f54-4c7589706fc8",
"status":"authorized",
"order_id":"ec7cf4f7-c250-415b-8f54-4c7589706fc8",
"void":false,
"expires":"2020-02-20T23:27:51Z",
"payable":0,
"merchant_id":"7KSWE7M9ANY6F48C",
"auth_hold":"redacted",
"refunded_amount":0,
"created":"2020-01-21T23:27:12Z",
"is_instore":false,
"amount":"redacted",
"is_marqeta_charge":false,
"balance":54436,
"financing_program":"b2.99_3z6z12r"
}