Bestfy API
  1. Transações
Bestfy API
  • Sobre a Bestfy
    • Comece aqui
  • Webhooks
    • O que é um Webhook?
  • Transações
    • Criar transações
      POST
    • Buscar transação
      GET
    • Listar transações
      GET
  1. Transações

Listar transações

Developing
GET
https://api.bestfy.io/transaction
Use este endpoint para carregar as transações exibidas no Bestfy. Combine paginação (page, limit) com filtros como status, method, deliveryStatus ou faixas de data para restringir o resultado e manter as respostas leves.

Regras de uso#

Sempre informe limit ≤ 40 para evitar erros de validação.
Utilize filtros de data em pares (createdFrom/createdTo, etc.) para manter a performance dos índices.
Para consultas por identificadores, prefira transactionId ou pixEndToEndId antes de aplicar filtros mais amplos.

Exemplo de requisição#

Paginação#

O campo transactionsAmount indica o total de registros encontrados. Para navegar, incremente page até que transactions retorne vazio.

Erros comuns#

CódigoMotivo
400Algum filtro inválido (ex.: limit > 40)
500Erro interno — reenvie após alguns segundos

Request

Query Params

Header Params

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.bestfy.io/transaction?page=1&limit=20' \
--header 'x-api-key;'
Response Response Example
{"transactions":[{"transactionId":"019bc7ea-9f84-0387-7135-f1d6f96bd929","status":"PAID","createdAt":"2026-01-16T17:46:40.887Z","updatedAt":"2026-01-16T17:47:16.767Z","product":"Produto 1","productType":"DIGITAL","customer":"João Pedro Teste de Webhook","customerEmail":"jpteste@gmail.com","paymentConfirmedAt":"2026-01-16T17:46:46.434Z","companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019bc7ea-9f7b-28e7-0b65-066f11074594","deliveryStatus":"PENDING","paymentMetadataId":"019bc7ea-9f78-4a59-26ae-0050dc2af86e","productId":"019bc7ea-9f5e-b286-61b9-03cf250ea8fa","value":5,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"CREDIT_CARD","value":5,"dueDate":null,"installmentsAmount":1,"installmentValueInCents":500}},{"transactionId":"019b2224-5b64-fb24-49d8-37deb47108e3","status":"PAID","createdAt":"2025-12-15T13:12:46.690Z","updatedAt":"2025-12-15T13:13:14.974Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":"2025-12-15T13:13:14.420Z","companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b2224-5b63-4650-211a-f0679a5c3afe","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":1.01,"pixEndToEndId":"E0000000020251215131308054973336","refundedAt":null,"paymentMetadata":{"method":"PIX","value":1.01,"dueDate":"2025-12-16T13:12:46.686Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b2220-10b6-3936-4d2d-0ac397c423d5","status":"PAID","createdAt":"2025-12-15T13:08:05.426Z","updatedAt":"2025-12-15T13:09:47.052Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":"2025-12-15T13:09:46.163Z","companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b2220-10b4-b678-3515-ae921b12ca81","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":1,"pixEndToEndId":"E0000000020251215130936904213682","refundedAt":null,"paymentMetadata":{"method":"PIX","value":1,"dueDate":"2025-12-16T13:08:05.372Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b221f-e360-782b-f3ab-aabc13aa00fe","status":"EXPIRED","createdAt":"2025-12-15T13:07:53.820Z","updatedAt":"2025-12-28T14:16:29.567Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b221f-e35e-aaf5-566e-f04fe5364688","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":1,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"BOLETO","value":1,"dueDate":"2025-12-18T13:07:53.811Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b194e-beab-e4a6-f62b-fdbc823dad0a","status":"PAID","createdAt":"2025-12-13T20:02:29.658Z","updatedAt":"2025-12-15T20:38:33.649Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":"2025-12-15T20:38:32.371Z","companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b194e-bea5-f977-b98f-05783da09d84","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":1,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"BOLETO","value":1,"dueDate":"2025-12-16T20:02:29.600Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b1945-a0cb-da85-9226-6964dfbc438f","status":"REFUNDED","createdAt":"2025-12-13T19:52:32.199Z","updatedAt":"2025-12-14T02:33:33.692Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":"2025-12-13T19:53:07.313Z","companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b1945-a0c8-cad8-cdf3-c1ba08cd85ac","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":1,"pixEndToEndId":"E0000000020251213195258729243057","refundedAt":"2025-12-14T02:33:33.692Z","paymentMetadata":{"method":"PIX","value":1,"dueDate":"2025-12-14T19:52:32.191Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b1944-d2f3-0b14-1ee2-c83288c67cf9","status":"EXPIRED","createdAt":"2025-12-13T19:51:39.504Z","updatedAt":"2025-12-24T14:09:24.681Z","product":"Caneta BIC - PRETA","productType":"COMMON","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b1944-d2f0-4451-8806-bfa9d8ede004","productId":"019b1941-0ce1-ea3f-ef7e-af6b4cf93565","value":10,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"PIX","value":10,"dueDate":"2025-12-14T19:51:39.498Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"019b1944-50b2-6539-77ed-fe56ef3acbb7","status":"CANCELED","createdAt":"2025-12-13T19:51:06.151Z","updatedAt":"2025-12-13T19:51:06.409Z","customer":"John Doe","customerEmail":"johndoe@email.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"019b1944-50ad-38e0-b72f-bb785b08d79a","deliveryStatus":"PENDING","paymentMetadataId":"019b1944-50a9-1dbe-2aa1-6250580df939","value":10,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"PIX","value":10,"dueDate":"2025-12-14T19:51:06.142Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"13feb468-e757-49c8-8cbc-f31674338681","status":"PRE_CHARGEBACK","createdAt":"2025-11-08T15:33:53.778Z","updatedAt":"2025-11-27T18:26:21.825Z","product":"Handmade Aluminum Ball","productType":"DIGITAL","customer":"Willie Moore-Beer","customerEmail":"Linda_Tremblay@yahoo.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"0432c620-2163-447b-b23f-7e378142ba7e","deliveryStatus":"DELIVERED","paymentMetadataId":"28f67fbb-e8d7-4bb9-a15a-5be3d520d1fe","productId":"09cc28a9-f01f-4d80-af8c-fcbb8fddc3c3","value":7456.93,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"BOLETO","value":7456.93,"dueDate":"2026-09-30T10:01:10.354Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"47631edd-c5a0-4068-94d6-19cbaa9ced5c","status":"MED","createdAt":"2024-11-29T21:55:14.540Z","updatedAt":"2025-11-27T18:26:21.825Z","product":"Practical Marble Bike","productType":"COMMON","customer":"Rachael Connelly","customerEmail":"Name46@hotmail.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"31b103c0-2bec-4549-963d-0a0555b5de24","deliveryStatus":"PENDING","paymentMetadataId":"c17609e6-f01c-4d46-9476-bc67b9c49780","productId":"1a254d68-47b4-4fc6-afef-75e1769f1137","value":9058.81,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"BOLETO","value":9058.81,"dueDate":"2026-11-14T18:58:33.795Z","installmentsAmount":null,"installmentValueInCents":null}},{"transactionId":"eac9519e-4007-4324-bff5-b21d76a8d714","status":"PAID","createdAt":"2024-09-03T18:57:17.675Z","updatedAt":"2025-11-27T18:26:21.825Z","product":"Awesome Silk Ball","productType":"DIGITAL","customer":"Minnie Bechtelar","customerEmail":"Dalton_DuBuque@hotmail.com","paymentConfirmedAt":null,"companyId":"a7b377bf-6222-4707-9b3b-764a35919636","customerId":"37dd0ad8-3fc5-4e4f-be9e-cc4b28e752b1","deliveryStatus":"PENDING","paymentMetadataId":"0a6e5a88-1d87-4c6e-9b19-31b026568126","productId":"b17106c7-b3db-46b1-8440-c0c743de239e","value":1886.35,"pixEndToEndId":null,"refundedAt":null,"paymentMetadata":{"method":"PIX","value":1886.35,"dueDate":"2026-06-30T04:30:22.836Z","installmentsAmount":null,"installmentValueInCents":null}}],"transactionsAmount":11}
Modified at 2026-01-27 20:03:25
Previous
Buscar transação
Built with