HomeGetting StartedSolutionsplatformsGlobal Integration
DocsRecipesAPI referenceChangelogAPI ReferenceRecipesChangelog
HomeGetting StartedSolutionsplatformsGlobal IntegrationLog In
API reference

Capture Transaction

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

Include the id returned in the authorize transaction response to capture a transaction.

Path Params
string
required

A unique ID representing the transaction’s loan or charge ID.

Body Params
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 | null

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

string | null

The shipping carrier used to ship the items.

string | null

The tracking number of the shipment.

integer | null
≥ 1

The amount to capture, used only for merchants that are enabled with split capture. The value is positive and is represented in the smallest currency unit, such as cents instead of dollars.

metadata
object

Unstructured metadata containing any additional data to be passed into each capture request.

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 5 months ago

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