HomeGetting StartedSolutionsPlatformsGlobal Integration
DocsRecipesAPI referenceChangelogAPI ReferenceRecipesChangelog
HomeGetting StartedSolutionsPlatformsGlobal IntegrationLog In
API reference
Start typing to search…

Authorize Transaction

post
https://api.global.sandbox.affirm.com/api/v1/transactions

Authorizes a transaction. Transaction authorization occurs after a user completes the Affirm checkout flow and returns to the merchant site. Authorizing a transaction generates a unique id that will be used as a reference moving forward.

Body Params

The request body used to create a transaction.

string

A comma-separated set of related objects to expand in the response. Allowed value is 'checkout'.

string
length between 1 and 128

Identifies the order within the merchant's order management system that this transaction corresponds to. It is only returned in the response if included in the request.

string
length between 9 and 16

A unique ID representing the checkout.

string
length between 1 and 128

An optional, unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

string

Three-letter ISO currency code in uppercase. Accepted currencies are USD, CAD, and GBP.

integer

The total amount of the checkout in the lowest denomination of the currency.

shipping
object
items
array of objects

An array of various details of the item being sold.

items
Headers
string

Unique identifier pre-generated by the client and used by the server to recognize successive calls to the same endpoint. This is required for Split Capture and encouraged for single transaction functionality. Note: If a request fails or times out, use the same idempotency key to retry the operation without risk of double-processing. For details, see the Idempotency section on About Split Capture.

string
required

Required param to identify the country in which Affirm is used and uses an "alpha-3" three-letter country code. Supported countries are the United States (USA), Canada (CAN), and the United Kingdom (GBR).

Responses

Updated 13 days ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
Updated 13 days ago