Visão geral dos endpoints
Resumo de requisitos por endpoint:
| Endpoint | Método | Tipo de chave | Extra |
|---|---|---|---|
/payments/merchant/transaction/pix | POST | PUBLIC | — |
/payments/merchant/transaction/pix/from-products | POST | PUBLIC | — |
/payments/merchant/transaction/:subTransactionId | GET | PUBLIC | param UUID |
/withdraws/merchant | POST | SECRET | scope CREATE_WITHDRAW |
/withdraws/merchant/quote | GET | SECRET | scope READ_WITHDRAWS |
/merchant/balance | GET | SECRET | scope READ_BALANCE |
/payments/transactions/:id/refunds | POST | SECRET | scope CREATE_REFUND + header Idempotency-Key |
/payments/transactions/:id/refunds | GET | SECRET | scope CREATE_REFUND |
/refunds/:id | GET | SECRET | scope CREATE_REFUND |
/merchant/orders | GET | SECRET | scope READ_ORDERS; paginação cursor |
/merchant/orders/:id | GET | SECRET | scope READ_ORDERS |
/merchant/orders/by-external-ref/:externalRef | GET | SECRET | scope READ_ORDERS |
/merchant/transactions | GET | SECRET | scope READ_TRANSACTIONS; paginação cursor |
/withdraws/merchant | GET | SECRET | scope READ_WITHDRAWS; paginação cursor |
/withdraws/merchant/:id | GET | SECRET | scope READ_WITHDRAWS |
/merchant/products | GET | SECRET | scope READ_PRODUCTS; paginação por página |
/merchant/products | POST | SECRET | scope WRITE_PRODUCTS |
/merchant/products/:id | GET | SECRET | scope READ_PRODUCTS |
/merchant/products/:id | PATCH | SECRET | scope WRITE_PRODUCTS |
/merchant/coupons | GET | SECRET | scope READ_COUPONS; paginação por página |
/merchant/coupons | POST | SECRET | scope WRITE_COUPONS |
/merchant/coupons/:id | GET | SECRET | scope READ_COUPONS |
/merchant/coupons/:id | PATCH | SECRET | scope WRITE_COUPONS |
/merchant/coupons/:id | DELETE | SECRET | scope WRITE_COUPONS |
/crypto/customers | POST | SECRET | scope CRYPTO_WRITE |
/crypto/customers/:id | GET | SECRET | scope CRYPTO_READ |
/crypto/deposits | POST | SECRET | scope CRYPTO_WRITE |
/crypto/deposits | GET | SECRET | scope CRYPTO_READ |
/crypto/deposits/intents/:id | GET | SECRET | scope CRYPTO_READ |
/crypto/balance | GET | SECRET | scope CRYPTO_READ |
/crypto/payouts | POST | SECRET | scope CRYPTO_WRITE + header Idempotency-Key |
/crypto/payouts/:id | GET | SECRET | scope CRYPTO_READ |
/crypto/withdrawals | POST | SECRET | scope CRYPTO_WRITE + header Idempotency-Key |
/crypto/withdrawals | GET | SECRET | scope CRYPTO_READ; paginação cursor |
/crypto/withdrawals/quote | GET | SECRET | scope CRYPTO_READ; cotação sem efeito, 60/min |
/crypto/withdrawals/:id | GET | SECRET | scope CRYPTO_READ |
Todas as rotas ficam sob https://api.gestaotechnology.com/api (ver Ambientes). Para a ordem das chamadas, veja o Guia de integração.