Capture Payment | Welcome to cash-app Documentation

This endpoint captures a full or partial payment. Any amounts successfully captured are settled from Cash App Afterpay to the merchant’s nominated bank account on the following day. Records of all payments captured against an order are returned in the events list as events of type, “CAPTURED”.

Note: Authorization expires after 13 days and then the transaction is automatically voided. Voided transactions are frozen and cannot be captured, reopened or changed in any way. In this case your only option is to use the v2/checkouts endpoint to create a new order.

This operation is idempotent based on the requestId (if provided), which allows the safe retry of multiple requests. This safe retry guarantees the payment operation only occurs once.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

This endpoint captures a full or partial payment. Any amounts successfully captured are settled from Cash App Afterpay to the merchant's nominated bank account on the following day. Records of all payments captured against an order are returned in the events list as events of type, "CAPTURED". **Note:** Authorization expires after 13 days and then the transaction is automatically voided. Voided transactions are frozen and cannot be captured, reopened or changed in any way. In this case your only option is to use the v2/checkouts endpoint to create a new order. This operation is idempotent based on the `requestId` (if provided), which allows the safe retry of multiple requests. This safe retry guarantees the payment operation only occurs once. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 70 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path Parameters

orderIdstringRequired

The unique ID of the Cash App Afterpay Order, returned as the id property of the Auth response.

Request

requestIdstringOptionalformat: "uuid"

A unique request ID, required for idempotent retries.

merchantReferencestringOptional

The reference/order ID that this payment corresponds to in the merchant’s system.

Note: Providing a new value updates any value previously set in the Create Checkout request.

amountobjectOptional

Object containing amount and currency

paymentEventMerchantReferencestringOptional<=128 characters

A unique reference for the individual payment capture event. If provided, the value appears in the daily settlement file as "Payment Event ID"

Response

If successful, returns an updated copy of the Payment object, with the newly captured payment appended to the events array as a Payment Event object with a type of “CAPTURED”.

idstring or null

The unique, permanent, Cash App Afterpay generated Order ID.

tokenstring or null

The token obtained from the checkout call

statusenum or null

represents the status of the order

Allowed values:

createdstring or null

is the UTC timestamp of when the payment was completed.

originalAmountobject or null

Object containing amount and currency

openToCaptureAmountobject or null

Object containing amount and currency

paymentStateenum or null

is the current state for capturing payments

merchantReferencestring or null

is the merchant’s order id/reference that the payment corresponds to.

refundslist of objects or null

orderDetailsobject or null

This comprehensive schema is designed to store an entire transaction's detail, covering crucial aspects like consumer information, billing and shipping details, courier particulars, item list, discounts, tax, and shipping amount.

eventslist of objects or null

Errors

This operation is idempotent based on the requestId (if provided), which allows the safe retry of multiple requests. This safe retry guarantees the payment operation only occurs once.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/payments/orderId/capture"
4
5	payload = {}
6	headers = {
7	"User-Agent": "User-Agent",
8	"Authorization": "Basic <username>:<password>",
9	"Content-Type": "application/json"
10	}
11
12	response = requests.post(url, json=payload, headers=headers)
13
14	print(response.json())

1	{
2	"id": "300000016189",
3	"token": "002.6bjbsaowxvfqam2nw4u3xudppheuh4gsuat3n2w3f6t44euzgy",
4	"status": "APPROVED",
5	"created": "2024-03-11T20:11:42.487Z",
6	"originalAmount": {
7	"amount": "37.00",
8	"currency": "USD"
9	},
10	"openToCaptureAmount": {
11	"amount": "0.00",
12	"currency": "USD"
13	},
14	"paymentState": "CAPTURED",
15	"merchantReference": "updated-k6-reference-utaddnpx",
16	"refunds": [],
17	"orderDetails": {
18	"consumer": {
19	"email": "test@example.com"
20	},
21	"billing": {
22	"name": "Joe Customer",
23	"line1": "1004 New Avenue",
24	"area1": "Melbourne",
25	"region": "VIC",
26	"postcode": "94121",
27	"countryCode": "AU",
28	"phoneNumber": "2120000000",
29	"countrycode": "US"
30	},
31	"courier": {
32	"shippedAt": "2024-01-01T08:00:00Z",
33	"name": "FedEx",
34	"tracking": "000 000 000 000",
35	"priority": "STANDARD"
36	},
37	"items": [
38	{
39	"name": "Blue Carabiner",
40	"quantity": 1,
41	"price": {
42	"amount": "40.00",
43	"currency": "USD"
44	},
45	"sku": "12341234"
46	}
47	],
48	"shipping": {
49	"name": "Joe Customer",
50	"line1": "1004 New Avenue",
51	"postcode": "94121",
52	"countrycode": "US",
53	"phoneNumber": "2120000000"
54	},
55	"categories": {
56	"name": "Jeans",
57	"sku": "123412345",
58	"quantity": 1,
59	"price": {
60	"amount": "20.00",
61	"currency": "USD"
62	},
63	"categories": null
64	}
65	},
66	"events": [
67	{
68	"id": "2dYbLXpOtEPQbg1DT7x9D8R4oCY",
69	"created": "2024-03-11T20:11:43.897Z",
70	"expires": {},
71	"type": "CAPTURED",
72	"amount": {
73	"amount": "37.00",
74	"currency": "USD"
75	},
76	"paymentEventMerchantReference": "k6-gsrdqspusf"
77	}
78	],
79	"discounts": [],
80	"shippingAmount": {
81	"amount": "10.00",
82	"currency": "USD"
83	},
84	"taxAmount": {
85	"amount": "0.00",
86	"currency": "USD"
87	}
88	}

Authentication

Path Parameters

Headers

Request

Response

Errors