Split Capture uses our Transactions API which represents Affirm loans issued to the end-user. You can use this API to interact with transactions via the `Transactions` object in order to change the state of that transaction, update metadata, or retrieve details.

Endpoints
<span style="color:blue">POST</span> [`v1/transactions`](🔗)
<span style="color:blue">POST</span> [`v1/transactions/id/capture`](🔗)
<span style="color:blue">POST</span> [`v1/transactions/id/void`](🔗)
<span style="color:blue">POST</span> [`v1/transactions/id/refund`](🔗)
<span style="color:blue">POST</span> [`v1/transactions/id/update`](🔗)
<span style="color:green">GET</span> [`v1/transactions/id`](🔗)</span>



## Authorization

Authorizing a transaction occurs after a user completes the Affirm checkout flow and returns to the merchant site. Authorizing the charge generates a `transaction_id` that will be used to reference it moving forward. You must authorize a transaction to fully create it.

### Endpoint

`<https://api.affirm.com/api/v1/transactions`>

### Body parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: Unique token used for authorization. Received to the `user_confirmation_url`
**order_id** `string` _Optional_: Identifies the order within the merchant's order management system that this transaction corresponds to. Only returned in the response if included in the request.
**reference_id** `string` _Optional_: A unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

### Request



### Response



## Capture

Capture the funds of an authorized transaction, similar to capturing a credit card transaction.

### Endpoint

<span style="color:blue">POST</span> `<https://api.affirm.com/api/v1/transactions/{transaction_id}/capture`>

### Path parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: A unique identifier representing the transaction. The value is an alphanumeric string of 9 or 12 characters in length, depending on whether it represents an installment loan or a lease, respectively.

### Body parameters

Parameters
**amount** `int32` <span style="color:red">REQUIRED</span>: Pass the amount to be captured. If you want to capture $50.80, the `amount` value would be 5080.
**order_id** `string` _Optional_: Identifies the order within the merchant's order management system that this transaction corresponds to. Only returned in the response if included in the request.
**reference_id** `string` _Optional_: A unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.
**shipping_carrier** `string` _Optional_: The shipping carrier (e.g. “USPS”) used to ship the items.
**shipping_confirmation** `string` _Optional_: The tracking number of the shipment.

### Request



### Response



## Void

Cancel an authorized transaction.

### Endpoint

<span style="color:blue">POST</span> `<https://api.affirm.com/api/v1/transactions/{transaction_id}/void`>

### Path parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: A unique identifier representing the transaction. The value is an alphanumeric string of 9 or 12 characters in length, depending on whether it represents an installment loan or a lease, respectively.

### Body parameters

Parameters
**amount** `int32` <span style="color:red">REQUIRED</span>: Pass the amount to be captured. If you want to capture $50.80, the `amount` value would be 5080.
**reference_id** `string` _Optional_: A unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

### Request



### Response



## Refund

Refund a transaction.

### Endpoint

<span style="color:blue">POST</span> `<https://api.affirm.com/api/v1/transactions/{transaction_id}/refund`>

### Path parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: A unique identifier representing the transaction. The value is an alphanumeric string of 9 or 12 characters in length, depending on whether it represents an installment loan or a lease, respectively.

### Body parameters

Parameters
**amount** `int32` <span style="color:red">REQUIRED</span>: Pass the amount to be captured. If you want to capture $50.80, the `amount` value would be 5080.
**reference_id** `string` _Optional_: A unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.

### Request



### Response



## Update

Update a transaction with new fulfillment or order information, such as shipment tracking number, shipping carrier, or order ID.

### Endpoint

<span style="color:blue">POST</span> `<https://api.affirm.com/api/v1/transactions/{transaction_id}`>

### Path parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: A unique identifier representing the transaction. The value is an alphanumeric string of 9 or 12 characters in length, depending on whether it represents an installment loan or a lease, respectively.

### Body parameters

Parameters
**order_id** `string` _Optional_: Identifies the order within the merchant's order management system that this transaction corresponds to. Only returned in the response if included in the request.
**reference_id** `string` _Optional_: A unique identifier that may be associated with each transaction event and reconciled with the system of record used by the merchant.
**shipping** `string` _Optional_: A `Contact` object containing the shipping information of the customer.
**shipping_carrier** `string` _Optional_: The shipping carrier (e.g. “USPS”) used to ship the items.
**shipping_confirmation** `string` _Optional_: The tracking number of the shipment.

### Request



### Response



## Read

Read the transaction information, current transaction status, and checkout data for one or more transactions. This is useful for updating your records or order management system with current transaction states before performing actions on them. It also allows you to keep your system in sync with Affirm if your staff manually manages loans in the merchant dashboard.

### Endpoint

<span style="color:green">GET</span> `<https://api.affirm.com/api/v1/transactions/{transaction_id}`>

### Path parameters

Parameters
**transaction_id** `string` <span style="color:red">REQUIRED</span>: A unique identifier representing the transaction. The value is an alphanumeric string of 9 or 12 characters in length, depending on whether it represents an installment loan or a lease, respectively.

### Query parameters

Parameters
**expand** `string` A comma-separated set of related objects to expand in the response. Valid values are: `events`

### Request



### Response