Lista os saques

GET/v1/withdrawals

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).
idstring
Só este saque.
statusstring
Só saques com este status (ex.: pending, paid, canceled).
methodstring
Só saques pagos por este meio (ex.: pix).

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+15 campos de data
- idstringobrigatório
  Identificador público (cash_…)
- feeintegerobrigatório
  Taxa do saque, em centavos.
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- amountintegerobrigatório
  Valor sacado, em centavos.
- methodstringobrigatóriopode ser nulo
  Como é pago (ex.: pix, ted).
- paidAtstringobrigatóriopode ser nulo
  Quando foi pago; null até lá.
- statusstringobrigatório
  Status: pending, processing, paid, canceled, failed…
- currencystringobrigatório
  Moeda (ISO 4217).
- 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.
- walletIdstringobrigatóriopode ser nulo
  A conta bancária em que é pago; null quando pago na sua chave Pix.
- 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 foi aprovado para pagamento; null até lá.
- transferCodestringobrigatóriopode ser nulo
  Identificador da transferência no banco; null até ser pago.
- receivingBankAccountobjectpode ser nulo
  Retrato da conta bancária de destino, tirado quando o saque foi pedido.
  +8 campos de receivingBankAccount
  - typestringobrigatóriopode ser nulo
    Tipo da conta.
  - pixKeystringobrigatóriopode ser nulo
    Chave Pix, quando pago a uma.
  - bankCodestringobrigatóriopode ser nulo
    Código do banco.
  - bankNamestringobrigatóriopode ser nulo
    Nome do banco.
  - documentstringobrigatóriopode ser nulo
    CPF/CNPJ do titular.
  - holderNamestringobrigatóriopode ser nulo
    Nome do titular da conta.
  - accountNumberstringobrigatóriopode ser nulo
    Número da conta.
  - routingNumberstringobrigatóriopode ser nulo
    Agência.
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

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

AnteriorConsulta um recebível PróximaCria um saque

{ "data": [ { "id": "cash_0a1b2c3d4e5f60718293", "fee": 5000, "_links": {}, "amount": 5000, "method": "string", "paidAt": "string", "status": "string", "currency": "BRL", "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "walletId": "wall_0a1b2c3d4e5f60718293", "createdAt": "string", "updatedAt": "string", "approvedAt": "string", "transferCode": "string", "receivingBankAccount": { "type": "string", "pixKey": "string", "bankCode": "string", "bankName": "string", "document": "string", "holderName": "JOAO SILVA", "accountNumber": "string", "routingNumber": "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 } }