Get payment details by PaymentId

EnvironmentMethodEndpoint
Sandboxhttps://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}
Productionhttps://apiquery.cieloecommerce.cielo.com.br/1/sales/{PaymentId}
ℹ️

Only transactions within the last three months can be queried via API.

Use the query to retrieve the IssuerTransactionId and the TransactionLinkId of the CIT transaction when the merchant has not stored them. See more details in Card Brand Identifiers.

TLID Mastercard

The Transaction Link Identifier (TLID), sent and returned in the TransactionLinkId field, is a unique identifier generated by the Mastercard card brand during a CIT transaction, used to link the related MIT transactions. The TLID applies to the Zero Auth response (response only) and to credit card, debit card, and merchant recurrence transactions.

For Mastercard, send IssuerTransactionId and TransactionLinkId together in MIT transactions: both parameters are mandatory.

PhaseDescription
Phase 1Current. TransactionLinkId available in the responses of card validation by Zero Auth, credit card payment creation, debit card payment creation, and in the query by PaymentId.
Phase 2Mandatory sending of the TransactionLinkId in the request (MIT) starting October 23, 2026.

Scheduled recurrence: in subsequent transactions, the IssuerTransactionId and TransactionLinkId fields are sent automatically.

The TransactionLinkId sent in the request must have exactly 22 characters (A-Z, a-z, 0-9, hyphens, and underscores). If the value doesn't match this format, Cielo ignores it and returns no error. When Cielo sends the TLID to the card brand, the response also includes the SentTransactionLinkId with the value sent. The Zero Auth request doesn't accept this field.

See more details in Card Brand Identifiers.


Path Params
string
required

Payment identification number. Size: 36.

Headers
string
required

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.

string
required

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.

string

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

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json