AFaffirm
Transactions API

Capture Transaction

Changed on

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

post/transactions/{transaction_id}/capture

Request

  • Base URL
    https://sandbox.affirm.com/api/v1
  • URL
    https://sandbox.affirm.com/api/v1/transactions/{transaction_id}/capture
  • Auth
    HTTP basic

Path parameters

transaction_idstring required
Example:ABCD-1234

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

Headers

Idempotency-Keystring

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 in About Split Capture.

Request body

order_idstring

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.

reference_idstring

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

shipping_carrierstring

The shipping carrier used to ship the items.

shipping_confirmationstring

The tracking number of the shipment.

amountinteger

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.

Example request

{
  "order_id": "order_125",
  "reference_id": "W1X2Y3Z4",
  "shipping_carrier": "USPS",
  "shipping_confirmation": "C12345678901234",
  "amount": 10000
}

Response

HTTP 200 OK

typestring

The type of event, such as auth, auth_expired, capture, charge_off, confirm, confirmation_expired, expire_authorization, expire_confirmation, refund, split_capture, update, void, partial_void, and refund_voided.

currencystring

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

createdstring

The time when the transaction event was created. The value is formatted in RFC 3339.

amountinteger

The total value of the transaction event, including tax and shipping. The value is non-negative and is represented in the smallest currency unit, such as cents instead of dollars. If the type is capture, this field represents the amount captured. If the type is refund, this field represents the amount refunded, including the fee that was refunded.

feeinteger

The correctness of this value may be inaccurate for certain loan types, refer to the settlement reports for the accurate merchant fee information for accounting and reconciliation purposes.

idstring

A unique ID for the transaction event.

Example response

{
  "type": "capture",
  "currency": "USD",
  "created": "2019-01-01T00:00:00.000Z",
  "amount": 20000,
  "fee": 500,
  "id": "ABCD-1234"
}

Changes

  • 360ca87d6c3eRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status