Capture credit transaction after authorization

put

https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/capture

Perform the partial or total capture of a credit card transaction.

Path Params

PaymentId

string

required

Order Identifier Field. Size: 36.

Query Params

Amount

int32

Order Amount (to be sent in cents). Size: 15.

ServiceTaxAmount

int32

Applicable to airlines companies only. Amount of the authorization value/amount that should be allocated to the service fee. Note: This value is not added to the authorization value. Size: 15.

Headers

MerchantId

string

required

Defaults to 8937bd5b-9796-494d-9fe5-f76b3e4da633

Store identifier in API E-commerce Cielo. Size: 36. This documentation provides a default MerchantId to allow testing in the sandbox, but you can also provide the enabled MerchantId during the deployment process.

MerchantKey

string

required

Defaults to XKGHUBSBKIRXKAVPSKWLVXYCLVJUGTNZLIHPUSYV

Public Key for Double Authentication in API E-commerce Cielo. Size: 40. This documentation provides a default MerchantKey to allow testing in the sandbox, but you can also provide the enabled MerchantKey during the deployment process.

RequestId

string

Request Identifier, used when the merchant uses different servers for each GET/POST/PUT. Size: 36.

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200