Capture Full Payment | Clearpay Documentation

This endpoint performs a payment capture for the full value of the payment plan.

Note

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

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

Approved Response (201)

If payment is approved by Clearpay, returns a Payment object in response, with a status of “APPROVED”.

Declined Response (201)

If payment is declined by Clearpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of “DECLINED”.

Please advise the consumer to contact the Clearpay Customer Service team for more information.

Connection Timeouts

Open timeout: 10 seconds
Read timeout: 70 seconds

Errors

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

HTTP Status Code	errorCode	Description
402 Payment Required	`invalid_token`	The checkout 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.
422 Unprocessable Entity	`invalid_object`	The checkout token was missing or empty.

This endpoint performs a payment capture for the full value of the payment plan. <Note title="Note"> This operation is [idempotent](/idempotent-requests) based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only performed once. Since the idempotency of this endpoint is based on the `token`, the inclusion of a `requestId` is not required. </Note> ## Approved Response (201) If payment is approved by Clearpay, returns a [Payment object](/payment-object) in response, with a `status` of "APPROVED". ## Declined Response (201) If payment is declined by Clearpay, for example, if invalid card details were entered, returns a [Payment object](/payment-object) in response, with a `status` of "DECLINED". Please advise the consumer to contact the Clearpay Customer Service team for more information. ## Connection Timeouts - Open timeout: 10 seconds - Read timeout: 70 seconds ## Errors In addition to the [PUT/POST Errors](/put-post-errors) applicable to all POST endpoints, the following errors are specific to Capture Full Payment: | HTTP Status Code | errorCode | Description | | :-- | :-- | :-- | | **402** <br />Payment Required | `invalid_token` | The checkout 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. | | **422** <br />Unprocessable Entity | `invalid_object` | The checkout token was missing or empty. |

Authentication

AuthorizationBasic

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

Request

This endpoint expects an object.

tokenstringRequired

The token returned in the Create Checkout request.

merchantReferencestringOptional

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

Response

Payment Approved or Declined - Returns a Payment object

idstring

The unique, permanent, Clearpay-generated Order ID.

tokenstring

Checkout token that was used to complete payment.

statusenum

An order status of "APPROVED" or "DECLINED".

Allowed values:

createdstringformat: "date-time"

The UTC timestamp of when the payment was completed, in ISO 8601 format.

originalAmountobject

openToCaptureAmountobject

paymentStateenum

Current state for capturing payments.

merchantReferencestring

The merchant’s order id/reference that this payment corresponds to.

refundslist of objects

An array of refunds. Note: in response to a Capture Full Payment call, this array will always be empty, since refunds cannot occur until payment is captured.

orderDetailsobject

eventslist of objects

One or more payment events that have occurred against the order.

Errors

This endpoint performs a payment capture for the full value of the payment plan.

Note

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

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

Approved Response (201)

If payment is approved by Clearpay, returns a Payment object in response, with a status of “APPROVED”.

Declined Response (201)

If payment is declined by Clearpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of “DECLINED”.

Please advise the consumer to contact the Clearpay Customer Service team for more information.

Connection Timeouts

Open timeout: 10 seconds
Read timeout: 70 seconds

Errors

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

HTTP Status Code	errorCode	Description
402 Payment Required	`invalid_token`	The checkout 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.
422 Unprocessable Entity	`invalid_object`	The checkout token was missing or empty.

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/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())

1	{
2	"id": "12345678",
3	"token": "ltqdpjhbqu3veqikk95g7p3fhvcchfvtlsiobah3u4l5nln8gii9",
4	"status": "APPROVED",
5	"created": "2019-01-01T00:00:00.000Z",
6	"originalAmount": {
7	"amount": "100.00",
8	"currency": "GBP"
9	},
10	"openToCaptureAmount": {
11	"amount": "0.00",
12	"currency": "GBP"
13	},
14	"paymentState": "CAPTURED",
15	"merchantReference": "merchantOrderId-1234",
16	"refunds": [],
17	"orderDetails": {
18	"consumer": {
19	"givenNames": "Joe",
20	"surname": "Consumer",
21	"email": "test@example.com"
22	}
23	},
24	"events": [
25	{
26	"id": "1OUR16OTqL3DgJ3ELlwKowU9v6K",
27	"created": "2019-01-01T00:00:00.000Z",
28	"expires": null,
29	"type": "CAPTURED",
30	"amount": {
31	"amount": "100.00",
32	"currency": "GBP"
33	}
34	}
35	]
36	}

Note

Approved Response (201)

Declined Response (201)

Connection Timeouts

Errors

Authentication

Headers

Request

Response

Errors

Note

Approved Response (201)

Declined Response (201)

Connection Timeouts

Errors