Consultar saque pela chave de idempotência
Retorna o saque criado com uma X-Idempotency-Key, para saber depois de um timeout se ele foi criado.
GET
apiKeyheader
AuthorizationBearer <token>Chave de API com o saque por API liberado: Authorization: Bearer <chave>.
idempotencyKey*stringA mesma X-Idempotency-Key enviada na criação.
Saque encontrado.
application/json- response
id*integerId do saque. É o payout.invoiceId dos eventos payout.*.
id_transaction*stringId da transação. É o payout.id dos eventos payout.*.
idempotencyKey*|A X-Idempotency-Key da criação.
status*stringStatus em português, para exibição. Decida pelo statusCode.
statusCode*WithdrawalStatusCodeStatus estável do saque. WITHDRAWAL_IN_PROGRESS e
WITHDRAWAL_IN_PROCESSING: aceito, o dinheiro ainda não saiu.
WITHDRAWAL_COMPLETED: o dinheiro saiu. WITHDRAWAL_FAILED: não saiu.
Valores aceitos
"WAITING_PROCESSING""WITHDRAWAL_IN_PROGRESS""WITHDRAWAL_IN_PROCESSING""WITHDRAWAL_COMPLETED""WITHDRAWAL_FAILED"amount*numberValor pedido, em reais.
fee*numberTarifa do saque, em reais.
amount_final*numberTotal debitado do saldo (valor + tarifa), negativo.
isUrgent*booleanreason*|Motivo da falha, quando houver.
transactionType*stringcreatedAt*stringFormato
date-timeupdatedAt*stringFormato
date-timecurl -X GET 'https://api.gates2b.com/v2/withdraw?idempotencyKey=string'Example Response
{ "id": 0, "id_transaction": "string", "idempotencyKey": "string", "status": "string", "statusCode": "WAITING_PROCESSING", "amount": 0, "fee": 0, "amount_final": 0, "isUrgent": true, "reason": "string", "transactionType": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Regras
404quer dizer que nenhum saque foi criado com a chave. Aí é seguro repetir o Criar saque com a mesma chave.- Se a criação respondeu
409comIDEMPOTENCY_KEY_IN_USE, espere alguns segundos e consulte aqui antes de repetir.