List Charges

get https://api.affirm.com/api/v2/charges

Get the charge information, current charge status, and checkout data for a list of charges.

Responses

Response body

object

transactions

array of objects

An array of charges.

transactions

object

string

A unique identifier representing the charge.

status

string

The status of the charge.

created

string

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

currency

string

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

amount

integer

The original amount financed to the customer in this charge. The value is non-negative and is represented in the smallest currency unit, such as cents instead of dollars.

authorization_hold

integer

The amount of the authorization hold on the charge.

payable

integer

The payable amount of the charge.

void

boolean

Indicates if the charge was voided.

expires

string

The time when the charge will expire. The value is formatted in RFC 3339.

order_id

string

Identifies the order within the merchant's order management system that this charge corresponds to.

events

array of objects

An array of TransactionEvent objects.

events

object

amount

integer

The total value of the charge, 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.

created

string

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

currency

string

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

fee

integer

The merchant fee.

fee_refunded

integer

Portion of the refunded amount that is subtracted from the merchant fee.

string

A unique identifier for the charge event.

transaction_id

string

length between 1 and 128

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

merchant_transaction_id

string | null

Your internal charge reference number; it may be different for each auth, capture, void, refund request for a single order.

order_id

string

length between 1 and 128

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

type

string

The type of event.

auth auth_expired capture confirm confirmation_expired refund split_capture update void partial_void refund_voided

details

array of objects

An array of Details objects.

details

object

product

object

shipping_amount

integer

The amount to ship the item.

tax_amount

integer

The shipping tax amount.

shipping

object

has_prev

boolean

Boolean indicating whether previous (newer) results exist

has_next

boolean

Boolean indicating whether next (older) results exist

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.affirm.com/api/v2/charges \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200HTTP 200 OK

400HTTP 400 Bad Request

401HTTP 401 Unauthorized

404HTTP 404 Not Found