Lista as transações

GET/v1/transactions

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
statusstring
Só cobranças com este status.
Valores:pendingpre-authorizedapprovedfailedrefusedcanceledrefundedchargebackdisputefraud-reviewanalyzingawaitingunauthorized
methodstring
Só cobranças com este meio de pagamento.
Valores:creditpixbilletnupay
customerIdstring
Só as cobranças deste cliente.
customeridstring
Apelido de customerId.
idstring
Só esta cobrança.
customidstring
Só a cobrança com este id personalizado.
referenceidstring
Só as cobranças com esta referência externa sua.
customeremailstring (email)
Só as cobranças do comprador com este e-mail.
customerdocumentstring
Só as cobranças do comprador com este documento (dígitos do CPF/CNPJ).
sourcestring
Só as cobranças desta origem.
ipaddressum de
Só as cobranças feitas deste endereço IP.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+14 campos de data
- idstringobrigatório
  Identificador público (tra_/trx_…)
- feesintegerobrigatório
  Total de taxas, em centavos.
- amountstringobrigatório
  Valor cobrado, em centavos (como texto).
- imagesstring[]obrigatório
  URLs das imagens dos itens.
- methodstringobrigatório
  Meio de pagamento.
- statusstringobrigatório
  Status da cobrança.
- currencystringobrigatório
  Moeda (ISO 4217).
- customIdstringobrigatóriopode ser nulo
  O seu id personalizado da cobrança; null em cobranças antigas.
- cardBrandstringobrigatóriopode ser nulo
  Bandeira do cartão; null nos outros meios.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- approvedAtstringobrigatóriopode ser nulo
  Quando a cobrança foi aprovada; null nos demais casos.
- customerIdstringobrigatóriopode ser nulo
  O comprador.
- originalAmountstringobrigatório
  Valor antes dos descontos, em centavos (como texto).
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorExclui um cartão PróximaCria uma transação (cobrança)

{ "data": [ { "id": "tra_0a1b2c3d4e5f60718293", "fees": 5000, "amount": "string", "images": [ "string" ], "method": "string", "status": "string", "currency": "BRL", "customId": "string", "cardBrand": "string", "createdAt": "string", "updatedAt": "string", "approvedAt": "string", "customerId": "cus_0a1b2c3d4e5f60718293", "originalAmount": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }