Withdraw POST

Método utilizado para solicitar transferência de saldo disponível em conta para conta bancária. O valor sempre será transferido para conta bancária que estiver marcada como "Padrão". Pode ocorrer casos que o sistema irá transferir o valor em duas operações, portanto, o retorno é um array de transferências.

/withdraw

Fields

Field Type Description Required
amount float

Valor solicitado para transferência

YES
comment string

Comentário para ser anexado a solicitação de transferência

NO

Request

Headers

Header Value
Accept
application/json
Content-Type
application/json
Authorization Bearer token

Request Body

{
   "amount":"2.00", 
   "comment": "Solicitação feita por João"
}

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity
  • 401: Unauthorized
  • 403: Forbidden

Headers

Header Value
Content-Type
application/json
Allow Comma-separated list of all HTTP methods allowed

Response Body

[
    {
        "id": "862",
        "pg_bank_account_id": "111",
        "amount": "100.00",
        "fee_amount": 0,
        "comment": "Solicitação feita por João",
        "status": "PENDING",
        "created_at": "2025-02-22 14:04:51",
        "updated_at": "2025-02-22 14:04:51"
    },
    {
        "id": "863",
        "pg_bank_account_id": "111",
        "amount": 10,
        "fee_amount": "3.50",
        "comment": "Solicitação feita por João",
        "status": "TRANSFERED",
        "created_at": "2025-02-22 14:04:51",
        "updated_at": "2025-02-22 14:04:51"
    }
]