AFaffirm
Transactions API

Void Transaction

Changed on

Voids an entire transaction.

post/transactions/{transaction_id}/void

Request

  • Base URL
    https://sandbox.affirm.com/api/v1
  • URL
    https://sandbox.affirm.com/api/v1/transactions/{transaction_id}/void
  • 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 on About Split Capture.

Request body

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.

amountinteger

The amount to void, 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

{
  "reference_id": "W1X2Y3Z4",
  "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.

createdstring

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

idstring

A unique ID for the transaction event.

Example response

{
  "type": "void",
  "created": "2019-01-01T00:00:00.000Z",
  "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