O objeto recipient representa um recebedor, que irá receber parte da venda realizada. Para criar um pedido com Split de pagamentos, você deve primeiramente cadastrar recebedores.
Este objeto possui os seguintes atributos:
| Atributos | Tipo | Descrição |
|---|---|---|
id | string | Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX. |
name | string | Nome do recebedor. |
email | string | E-mail do recebedor. |
document | string | CPF ou CNPJ do recebedor. |
description | string | Descrição do recebedor. |
type | enum | Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). |
status | string | Status do recebedor. Valores possíveis: active ou inactive. |
created_at | datetime | Data de criação do recebedor. |
updated_at | datetime | Data de atualização do recebedor. |
deleted_at | datetime | Data de exclusão do recebedor. |
default_bank_account | object | Conta bancária do recebedor. |
transfer-settings | object | Informações de transferência do recebedor. |
gateway_recipients | object | Informações do recebedor no gateway. |
metadata | object | Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor. Saiba mais sobre metadata |
SPLIT DE PAGAMENTOS SÓ ESTÁ DISPONÍVEL PARA PAGAR.ME
As funcionalidades do Split de Pagamento só estão disponíveis para contas configuradas com um gateway específico chamado Pagar.me .