Capture Payment | Clearpay Documentation

This endpoint performs a direct payment capture and is the equivalent of capturing a credit card.

This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.

Note

Since the idempotency of this endpoint is based on the token, the inclusion of a requestId is not required.

Successful Response (201)

If payment is approved by Clearpay, returns a Payment object in response.

Note

The Payment object is only returned if the payment is approved by Clearpay and successfully captured. If the payment is declined or fails, an error object is returned. See the Errors section below.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Capture Payment:

HTTP Status Code	errorCode	Description
402 Payment Required	`declined`	The consumer’s payment has been declined. For example, invalid card details were entered during the Clearpay screenflow. Please advise the consumer to contact the Clearpay Customer Service team for more information.
412 Precondition Failed	`invalid_token`	The order token is invalid, expired, or does not exist.
412 Precondition Failed	`invalid_order_transaction_status`	The Consumer has not confirmed their payment for the order associated with this token.

This endpoint performs a direct payment capture and is the equivalent of capturing a credit card. This operation is [idempotent](/v-1/idempotent-requests) based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once. <Note title="Note"> Since the idempotency of this endpoint is based on the `token`, the inclusion of a `requestId` is not required. </Note> ## Successful Response (201) If payment is approved by Clearpay, returns a [Payment object](/v-1/payment-object) in response. <Note title="Note"> The [Payment object](/v-1/payment-object) is only returned if the payment is approved by Clearpay and successfully captured. If the payment is declined or fails, an error object is returned. See the Errors section below. </Note> ## Connection Timeouts | Timeout | Time (Seconds) | | :------ | :------------- | | Open | 10 | | Read | 70 | ## Errors In addition to the [PUT/POST Errors](/v-1/put-post-errors) applicable to all POST endpoints, the following errors are specific to Capture Payment: | HTTP Status Code | errorCode | Description | | :-- | :-- | :-- | | **402** <br />Payment Required | `declined` | The consumer's payment has been declined. For example, invalid card details were entered during the Clearpay screenflow. Please advise the consumer to contact the Clearpay Customer Service team for more information. | | **412** <br />Precondition Failed | `invalid_token` | The order token is invalid, expired, or does not exist. | | **412** <br />Precondition Failed | `invalid_order_transaction_status` | The Consumer has not confirmed their payment for the order associated with this token. |

Authentication

AuthorizationBasic

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

Request

This endpoint expects an object.

tokenstringRequired

The token returned in the Create Order request.

merchantReferencestringOptional

The merchant’s order id/reference that this payment corresponds to. This will update any value previously provided in the Create Order request.

This endpoint performs a direct payment capture and is the equivalent of capturing a credit card.

This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once.

Note

Since the idempotency of this endpoint is based on the token, the inclusion of a requestId is not required.

Successful Response (201)

If payment is approved by Clearpay, returns a Payment object in response.

Note

The Payment object is only returned if the payment is approved by Clearpay and successfully captured. If the payment is declined or fails, an error object is returned. See the Errors section below.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Capture Payment:

HTTP Status Code	errorCode	Description
402 Payment Required	`declined`	The consumer’s payment has been declined. For example, invalid card details were entered during the Clearpay screenflow. Please advise the consumer to contact the Clearpay Customer Service team for more information.
412 Precondition Failed	`invalid_token`	The order token is invalid, expired, or does not exist.
412 Precondition Failed	`invalid_order_transaction_status`	The Consumer has not confirmed their payment for the order associated with this token.

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v1/payments/capture"
4
5	payload = { "token": "string" }
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())

Note

Successful Response (201)

Note

Connection Timeouts

Errors

Authentication

Headers

Request

Note

Successful Response (201)

Note

Connection Timeouts

Errors