curl --request GET \
--url 'https://app.amplopay.com/api/v1/gateway/transactions?clientIdentifier=5286-412312-asd-123' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
{
"id": "cmry2h8332sgs3ub44fh7",
"clientIdentifier": "5286-412312-asd-123",
"currency": "BRL",
"amount": 49.8,
"chargeAmount": 49.8,
"exchangeRate": 1,
"producerExtraAmount": 0,
"status": "FAILED",
"statusDescription": null,
"purchaseType": "ONCE",
"paymentMethod": "PIX",
"details": null,
"errorDescription": "Transaction denied by anti-fraud",
"webhookUrl": null,
"availableAt": null,
"createdAt": "2026-08-20T00:00:00.000Z",
"refundedAt": null,
"payedAt": null,
"boletoInformation": null,
"pixInformation": {
"qrCode": "00020101065465468949845BR.GOV.BCB.PIX...",
"image": "https://upload.wikimedia.org/wikipedia/commons/f/fa/Link_pra_pagina_principal_da_Wikipedia-PT_em_codigo_QR_b.svg",
"base64": ""
},
"pixMetadata": {
"payerBankName": "Caixa Economica Federal",
"payerDocument": "123.456.789-00",
"payerName": "João da Silva",
"receiverBankName": "Banco do Brasil",
"receiverDocument": "987.654.321-00",
"receiverName": "Maria da Silva",
"receiverPixKey": "98765432100"
}
}
Endpoints
Search transactions
Query transactions created through the API
GET
/
gateway
/
transactions
curl --request GET \
--url 'https://app.amplopay.com/api/v1/gateway/transactions?clientIdentifier=5286-412312-asd-123' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
{
"id": "cmry2h8332sgs3ub44fh7",
"clientIdentifier": "5286-412312-asd-123",
"currency": "BRL",
"amount": 49.8,
"chargeAmount": 49.8,
"exchangeRate": 1,
"producerExtraAmount": 0,
"status": "FAILED",
"statusDescription": null,
"purchaseType": "ONCE",
"paymentMethod": "PIX",
"details": null,
"errorDescription": "Transaction denied by anti-fraud",
"webhookUrl": null,
"availableAt": null,
"createdAt": "2026-08-20T00:00:00.000Z",
"refundedAt": null,
"payedAt": null,
"boletoInformation": null,
"pixInformation": {
"qrCode": "00020101065465468949845BR.GOV.BCB.PIX...",
"image": "https://upload.wikimedia.org/wikipedia/commons/f/fa/Link_pra_pagina_principal_da_Wikipedia-PT_em_codigo_QR_b.svg",
"base64": ""
},
"pixMetadata": {
"payerBankName": "Caixa Economica Federal",
"payerDocument": "123.456.789-00",
"payerName": "João da Silva",
"receiverBankName": "Banco do Brasil",
"receiverDocument": "987.654.321-00",
"receiverName": "Maria da Silva",
"receiverPixKey": "98765432100"
}
}
Queries created transactions.
Do not use this endpoint for frequent polling. Configure webhooks to receive real-time status updates.
Query parameters
string
Transaction ID returned by the API.
string
Identifier you sent when creating the transaction.
Request example
curl --request GET \
--url 'https://app.amplopay.com/api/v1/gateway/transactions?clientIdentifier=5286-412312-asd-123' \
--header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
--header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI'
Response
string
required
Transaction ID.
string
required
Identifier sent by your application when creating the transaction.
string
required
Transaction currency.
number
required
Transaction amount.
number
required
Amount charged to the customer.
string
required
Transaction status.
string
required
Payment method used for the transaction.
{
"id": "cmry2h8332sgs3ub44fh7",
"clientIdentifier": "5286-412312-asd-123",
"currency": "BRL",
"amount": 49.8,
"chargeAmount": 49.8,
"exchangeRate": 1,
"producerExtraAmount": 0,
"status": "FAILED",
"statusDescription": null,
"purchaseType": "ONCE",
"paymentMethod": "PIX",
"details": null,
"errorDescription": "Transaction denied by anti-fraud",
"webhookUrl": null,
"availableAt": null,
"createdAt": "2026-08-20T00:00:00.000Z",
"refundedAt": null,
"payedAt": null,
"boletoInformation": null,
"pixInformation": {
"qrCode": "00020101065465468949845BR.GOV.BCB.PIX...",
"image": "https://upload.wikimedia.org/wikipedia/commons/f/fa/Link_pra_pagina_principal_da_Wikipedia-PT_em_codigo_QR_b.svg",
"base64": ""
},
"pixMetadata": {
"payerBankName": "Caixa Economica Federal",
"payerDocument": "123.456.789-00",
"payerName": "João da Silva",
"receiverBankName": "Banco do Brasil",
"receiverDocument": "987.654.321-00",
"receiverName": "Maria da Silva",
"receiverPixKey": "98765432100"
}
}
⌘I