Gates2b

Consultar saque

Retorna um saque da conta pelo id devolvido na criação, com o status atual.

GET
/v2/withdraw/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

Chave de API com o saque por API liberado: Authorization: Bearer <chave>.

Path Parameters

id*integer

id numérico do saque.

Intervalo1 <= value

Response Body

Saque encontrado.

application/json
  1. response
id*integer

Id do saque. É o payout.invoiceId dos eventos payout.*.

id_transaction*string

Id da transação. É o payout.id dos eventos payout.*.

idempotencyKey*|

A X-Idempotency-Key da criação.

status*string

Status em português, para exibição. Decida pelo statusCode.

statusCode*WithdrawalStatusCode

Status 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*number

Valor pedido, em reais.

fee*number

Tarifa do saque, em reais.

amount_final*number

Total debitado do saldo (valor + tarifa), negativo.

isUrgent*boolean
reason*|

Motivo da falha, quando houver.

transactionType*string
createdAt*string
Formatodate-time
updatedAt*string
Formatodate-time
Example Request
curl -X GET 'https://api.gates2b.com/v2/withdraw/1'
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

  • Decida pelo statusCode. O status é texto para exibição e pode mudar.
  • WITHDRAWAL_COMPLETED é o único status em que o dinheiro saiu. WITHDRAWAL_IN_PROGRESS e WITHDRAWAL_IN_PROCESSING ainda podem terminar em WITHDRAWAL_FAILED.

Nesta página