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.
Since the idempotency of this endpoint is based on the token, the inclusion of a requestId is not required.
If payment is approved by Clearpay, returns a Payment object in response.
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.
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Capture Payment:
Basic authentication of the form Basic <base64(username:password)>.
The token returned in the Create Order request.
The merchant’s order id/reference that this payment corresponds to. This will update any value previously provided in the Create Order request.