Jump to Content
DevelopersHomePaymentsPlatformsGlobal Integration
DocsRecipesAPI referenceAnnouncements
HomePaymentsPlatformsGlobal IntegrationLog InDevelopers
Log In
DocsRecipesAPI referenceAnnouncements

Affirm API

  • Introduction
  • Authentication
  • Errors
  • Metadata
  • Data types

Merchant Transaction API

  • Transactions API endpoints
  • Transactions API
    • List Transactionsget
    • Authorize Transactionpost
    • List Transaction Eventsget
    • Read Transactionget
    • Update Transactionpost
    • Capture Transactionpost
    • Refund Transactionpost
    • Void Transactionpost

Charges API

  • Charges API
    • The charge object
    • The event object
    • Authorize Chargepost
    • List Chargesget
    • List charge eventsget
    • Read Chargeget
    • Capture Chargepost
    • Refund Chargepost
    • Update Chargepost
    • Void Chargepost

Checkout API

  • The checkout object
    • The merchant object
    • The discount object
    • The metadata object
    • The item object
    • The customer object
    • The itinerary object
    • Shipping & billing objects
    • Name object
    • Address object
  • Checkout
    • Read Checkoutget
    • Storepost
    • Directpost
    • Update Checkoutpost
    • Resend Checkoutpost

Cards API

  • Cards API
    • The card object
    • The billing object
    • Name object
    • Address object
    • The response object
    • Read Cardget
    • Cancel Cardpost
    • Finalize a cardpost

Affirm API

  • Introduction
  • Authentication
  • Errors
  • Metadata
  • Data types

Merchant Transaction API

  • Transactions API endpoints
  • Transactions API
    • List Transactionsget
    • Authorize Transactionpost
    • List Transaction Eventsget
    • Read Transactionget
    • Update Transactionpost
    • Capture Transactionpost
    • Refund Transactionpost
    • Void Transactionpost

Charges API

  • Charges API
    • The charge object
    • The event object
    • Authorize Chargepost
    • List Chargesget
    • List charge eventsget
    • Read Chargeget
    • Capture Chargepost
    • Refund Chargepost
    • Update Chargepost
    • Void Chargepost

Checkout API

  • The checkout object
    • The merchant object
    • The discount object
    • The metadata object
    • The item object
    • The customer object
    • The itinerary object
    • Shipping & billing objects
    • Name object
    • Address object
  • Checkout
    • Read Checkoutget
    • Storepost
    • Directpost
    • Update Checkoutpost
    • Resend Checkoutpost

Cards API

  • Cards API
    • The card object
    • The billing object
    • Name object
    • Address object
    • The response object
    • Read Cardget
    • Cancel Cardpost
    • Finalize a cardpost

Transactions API endpoints

When you initiate an Affirm checkout request, you define a success callback which will hit our Transactions endpoint and create a Transaction object. You can retrieve and refund individual transactions as well as read all transactions. Transactions are identified by a unique, random ID.


Authorize transaction

POST v1/transactions - Authorizes a transaction.

Void transaction

POST v1/transactions/id/void - Voids a transaction

Capture transaction

POST v1/transactions/id/capture - Captures a transaction and initiates transfer of funds to a merchant.

Refund transaction

POST v1/transactions/id/refund - Fully or partially refund a transaction.

Update transactions

POST v1/transactions/id - Updates a transaction by specifiying the values of the parameters passed.

Read transaction

GET v1/transactions/id - Retrieves transaction data.

List transactions

GET v1/transactions - Returns a list of transactions.

List transaction events

GET v1/transactions/events - Retrieves a list of transaction events.