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. Cada recebedor deve ser criado somente uma vez e poderá ser utilizado em qualquer quantidade de pedidos.
Por exemplo, vamos supor que seu marketplace tem duas lojas cadastradas. Para realizar split entre essas lojas e seu marketplace, você terá que criar três recebedores:
- Marketplace
- Loja 1
- Loja 2
Dessa forma, quando você criar um pedido com Split para a loja 1, você irá enviar o recebedor da loja 1, o recebedor do marketplace e sua regra de divisão para este pedido.
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: registration, affiliation, active, refused, suspended, blocked, 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 .
Status do Recebedor
Recebedores podem receber os seguintes status:
registration: Estágio no qual o recebedor já passou pelo pré-credenciamento e está com o auto credenciamento pendente. Aqui ele pode transacionar, mas não pode realizar um saque.
affiliation: Estágio no qual o recebedor já passou pelo auto credenciamento e está esperando a afiliação por parte do Pagar.me. Ele continua podendo transacionar, mas não pode realizar um saque.
active: Estágio no qual o recebedor já passou por todos os estágios do credenciamento e esta apto a transacionar e realizar saques.
refused: Estágio no qual o recebedor foi recusado no pré-credenciamento ou na afiliação. Nesse estágio o recebedor não esta apto a realizar transações e saques.
suspended: Estágio no qual o recebedor não se auto credenciou após um período de dias, ou teve pendências no estágio de afiliação. Nesse estágio o recebedor não esta apto a realizar transações e saques.
blocked: Estágio no qual após ativo, mostrou comportamento suspeito. Nesse estágio o recebedor não esta apto a realizar transações e saques.
inactive: Estágio no qual após ser monitorado, mostrou comportamento suspeito, e comprovamos algo de errado. Nesse estágio o recebedor não esta apto a realizar transações e saques.