v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Cria saque

Rota para realizar o saque para uma conta bancária de um recebedor.

post/recipients/recipient_id/withdrawals

Path parameters

recipient_idstring required

Código do recebedor

Request body

amountinteger

Valor da cobrança em centavos

Response

200

idstring

amountinteger

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "with_LJ0OkmVcJCVPj4Yp",
  "amount": 100,
  "status": "failed",
  "created_at": "2020-01-16T16:36:39Z",
  "updated_at": "2020-01-16T16:36:39Z",
  "bank_account": {
    "id": "ba_jGXwbQtNASZZrdpE",
    "holder_name": "Second recipient",
    "holder_type": "company",
    "holder_document": "15313587000166",
    "bank": "341",
    "branch_number": "12345",
    "branch_check_digit": "6",
    "account_number": "12345",
    "account_check_digit": "6",
    "type": "checking",
    "status": "active",
    "created_at": "2020-01-02T20:23:17Z",
    "updated_at": "2020-01-02T20:23:17Z",
    "metadata": {
      "meta_key": "meta_value"
    },
    "recipient": {
      "id": "rp_yLnAyVpHbQIqZxwO",
      "name": "Second recipient",
      "email": "second_recipient@mundipagg.com",
      "document": "15313587000166",
      "description": "Descrição do recebedor 2",
      "type": "company",
      "status": "active",
      "created_at": "2020-01-02T20:23:17Z",
      "updated_at": "2020-01-02T20:23:17Z"
    }
  }
}