Listar saques
Lista os saques da conta, do mais recente para o mais antigo, com paginação por número de página.
Lista os saques da conta, do mais recente para o mais antigo, com paginação por número de página.
ApiKeyAuthorization<token>A chave de API crua, sem prefixo: kpa_test_sk_… no sandbox e kpa_live_sk_… em produção.
Use apenas no servidor.
status?string"processando""transferido""rejeitado""cancelado""devolvido""expirado""falha"dateFrom?stringCriados a partir desta data. Sem fuso, vale UTC.
dateTo?stringCriados até esta data. Data sem hora vai até 23:59:59 UTC. Precisa ser maior ou igual a dateFrom.
page?integer1 <= value1pageSize?integer1 <= value <= 10020Página de saques.
application/json- response
items?array<>totalCount?integerpage?integerpageSize?integertotalPages?integercurl -X GET 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/withdrawals'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "processando", "amount": 0, "currencyCode": "BRL", "pixKeyType": "CPF", "pixKey": "string", "createdAt": "2019-08-24T14:15:22Z", "pixEndToEndId": "string", "transferredAt": "2019-08-24T14:15:22Z", "rejectedAt": "2019-08-24T14:15:22Z", "rejectionReason": "string", "rejectionSource": "operator", "failedAt": "2019-08-24T14:15:22Z", "failureCode": "string", "failureMessage": "string" } ], "totalCount": 0, "page": 0, "pageSize": 0, "totalPages": 0}Consultar saque GET
Devolve o estado atual de um saque. Saque de outra conta responde `404`, igual a um inexistente.
Solicitar saque POST
Cria um pedido de saque por Pix para a chave de destino cadastrada da conta. O valor é reservado no saldo e o pedido entra em análise. `201` confirma o pedido, não o envio do Pix. `amount` é inteiro em centavos, como nas cobranças: `25000` é R$ 250,00. Decimal ou texto recebem `400 withdrawal.validation_failed`. No sandbox, o Pix de saída é simulado.