Sign in

v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criar recebedor

Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.

post/recipients

Request body

codestring

Referencia externa única por recebedor

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.

Response

200

idstring
namestring
emailstring
codestring
documentstring
typestring
payment_modestring
statusstring
created_atstring
updated_atstring

Example response

{
  "id": "re_clxnqkxk709sc019taqhmj4kf",
  "name": "Antonio da Silva",
  "email": "tstark@avengers.com",
  "code": "21875b51-d4c3-46d3-aeee-d8b3112aab55",
  "document": "26224451990",
  "type": "individual",
  "payment_mode": "bank_transfer",
  "status": "active",
  "created_at": "2024-06-20T20:50:31Z",
  "updated_at": "2024-06-20T20:50:31Z",
  "transfer_settings": {
    "transfer_enabled": true,
    "transfer_interval": "Weekly",
    "transfer_day": 1
  },
  "default_bank_account": {
    "id": "ba_LlpvMnqcXSO2EVW8",
    "holder_name": "Tony Stark",
    "holder_type": "individual",
    "holder_document": "26224451990",
    "bank": "341",
    "branch_number": "1234",
    "branch_check_digit": "6",
    "account_number": "12345",
    "account_check_digit": "6",
    "type": "checking",
    "status": "active",
    "created_at": "2024-06-20T20:50:31Z",
    "updated_at": "2024-06-20T20:50:31Z",
    "metadata": {
      "key": "value"
    }
  },
  "gateway_recipients": [
    {
      "gateway": "pagarme",
      "status": "active",
      "pgid": "re_clxnqkxk709sc019taqhmj4kf",
      "createdAt": "2024-06-20T20:50:31Z",
      "updatedAt": "2024-06-20T20:50:31Z"
    }
  ],
  "automatic_anticipation_settings": {
    "type": "full",
    "delay": 365
  },
  "metadata": {
    "key": "value"
  },
  "register_information": {
    "email": "tstark@avengers.com",
    "document": "26224451990",
    "type": "individual",
    "site_url": "http://www.site.com",
    "phone_numbers": [
      {
        "ddd": "77",
        "number": "987655432",
        "type": "mobile"
      }
    ],
    "name": "Antonio da Silva",
    "mother_name": "Maria da Silva",
    "birthdate": "02/10/1990",
    "monthly_income": "3000",
    "professional_occupation": "Professor",
    "address": {
      "street": "Rua Alberto Carvalho",
      "complementary": "Apto. 345",
      "street_number": "111",
      "neighborhood": "Gomes Pereira",
      "city": "Porto Seguro",
      "state": "BA",
      "zip_code": "44900000",
      "reference_point": "Próximo ao Posto Quatro Rodas"
    }
  }
}