Criando um recebedor

POST

/v1/recipients

Última modificação:2025-01-13 10:16:30

Requisição

Parâmetros Bodyapplication/json

Exemplo

{
    "external_id": "123B",
    "transfer_interval": "weekly",
    "transfer_day": 5,
    "anticipation_enabled": true,
    "has_wallet": false,
    "bank_account": {
        "bank_code": "077",
        "agencia": "3091",
        "agencia_dv": "1",
        "conta": "62846",
        "conta_dv": "5",
        "type": "conta_corrente",
        "document_number": "17985452095",
        "legal_name": "Empresa teste c1"
    },
    "register_information": {
        "type": "individual",
        "document_number": "17985452095",
        "legal_name": "Empresa teste c1",
        "email": "exemplo@site.com",
        "phone_number": "5511962428535",
        "street": "Rua Oceano Pacífico",
        "street_number": "903",
        "complement": null,
        "neighborhood": "Centro",
        "city": "Várzea Grande",
        "state": "mt",
        "country": "br",
        "zipcode": "78150220"
    },
    "metadata": "teste|123"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://prod.your-api-server.com/v1/recipients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_id": "123B",
    "transfer_interval": "weekly",
    "transfer_day": 5,
    "anticipation_enabled": true,
    "has_wallet": false,
    "bank_account": {
        "bank_code": "077",
        "agencia": "3091",
        "agencia_dv": "1",
        "conta": "62846",
        "conta_dv": "5",
        "type": "conta_corrente",
        "document_number": "17985452095",
        "legal_name": "Empresa teste c1"
    },
    "register_information": {
        "type": "individual",
        "document_number": "17985452095",
        "legal_name": "Empresa teste c1",
        "email": "exemplo@site.com",
        "phone_number": "5511962428535",
        "street": "Rua Oceano Pacífico",
        "street_number": "903",
        "complement": null,
        "neighborhood": "Centro",
        "city": "Várzea Grande",
        "state": "mt",
        "country": "br",
        "zipcode": "78150220"
    },
    "metadata": "teste|123"
}'

Respostas

🟢200Criando um Recebedor passando o Objeto do bank account

application/json

Body

Exemplo

{
    "id": 4,
    "transfer_enabled": true,
    "transfer_interval": "monthly",
    "transfer_day": 5,
    "register_information": {
        "type": "individual",
        "document_number": "01035430231",
        "legal_name": "Sarah Elza Tereza da Mata",
        "address": "Rua Oceano Pacífico",
        "street_number": "903",
        "city": "Várzea Grande",
        "state": "mt",
        "zipcode": "78150220"
    },
    "bank_account": {
        "id": 4,
        "bank_code": "077",
        "agencia": "3091",
        "agencia_dv": null,
        "conta": "62846",
        "conta_dv": "5",
        "type": "conta_corrente",
        "document_number": "01035430231",
        "legal_name": "Sarah Elza Tereza da Mata",
        "created_at": "2023-07-06T08:25:02.000000Z",
        "updated_at": "2023-07-06T08:25:02.000000Z"
    },
    "created_at": "2023-07-06T08:25:02.000000Z",
    "updated_at": "2023-07-06T08:25:02.000000Z"
}

Modificado em 2025-01-13 10:16:30

Página anterior

Tax

Próxima página

Atualizando um recebedor