7. Multipagamentos

O Multipagamento é uma coleção de pagamentos associados a um multipedido. Usado para a implementação de carrinhos com mais de um lojista e situações em que seja necessário cobrar de forma distinta diferentes itens dentro de um único checkout. Ao criar um multipagamento, o Moip cria automaticamente um pagamento para cada pedido do multipedido e realiza a cobrança automática.

Em casos de cartão de crédito, são geradas múltiplas autorizações, uma para cada pagamento, separando as cobranças na fatura do cliente e com isso facilitando a gestão do Marketplace ou Plataforma.

Atributos

Nome

Descrição

Tipo

id

Id Moip do multipagamento.

string(16),
response

status

Status do multipagamento. Valores possíveis: WAITING, IN_ANALYSIS, PRE_AUTHORIZED, AUTHORIZED, CANCELLED, REFUNDED, REVERSED.

string,
response

amount

Valores do multipagamento.

structured

├─currency

Moeda utilizada. Valores possíveis: BRL.

string,
response

└─total

Valor total do multipagamento. Em centavos Ex: R$10,32 será informado 1032

integer(12),
response

installmentCount

Número de parcelas. Válido para pagamentos por cartão. Se não for informado, o pagamento será realizado em 1 parcela. Mínimo 1 e Máximo 12.

integer(2)

delayCapture

Opção para o uso de pré-autorização. Ao setar o atributo para "true", o pagamento será pré-autorizado e ficará disponível para captura posterior. Veja como capturar aqui.

boolean

fundingInstrument

Meio de pagamento utilizado.

structured

├─method

Meio de pagamento. Valores possíveis: CREDIT_CARD, BOLETO, ONLINE_BANK_DEBIT, WALLET.

string,
obrigatório

├─creditCard

Dados do cartão de crédito utilizado no pagamento. Para saber mais veja seção Criar Multipagamento via Cartão de Crédito

object

├─boleto

Dados do boleto utilizado no pagamento. Mais informações na seção Criar Multipagamento via Boleto.

object

├─onlineBankDebit

Dados da transferência bancária utilizada no pagamento. Visite a seção Criar Multipagamento via Débito Online para saber mais.

object

└─wallet

Dados da carteira eletrônica utilizada no pagamento. Não disponível nesta versão da API.

object

cancellationDetails

Detalhes do cancelamento de pagamentos de cartão de crédito.

structured

├─cancelledBy

Responsável pelo cancelamento. Valores possíveis: MOIP ou ACQUIRER (adquirente).

string,
response

├─code

Código do motivo de cancelamento. Valores possíveis: ver lista de Detalhes de Cancelamento de Pagamentos.

integer,
response

└─description

Descrição do motivo de cancelamento.

string,
response

updatedAt

Data da atualização do recurso.

datetime,
response

_links

Estrutura de links Hypermedia (HATEOAS) do recurso.

structured,
response

├─self

Hyperlink para o próprio recurso.

structured

├─└─href

Hyperlink para o próprio recurso.

link,
response

└─checkout

Links para checkout.

object,
response

_links

Estrutura de links Hypermedia (HATEOAS) do recurso.

structured,
response

├─self

Referência para o próprio recurso.

structured

├ └─href

Hyperlink para o próprio recurso.

link

├─order

Referência para o Pedido.

structured

├ ├─title

Identificador do Pedido.

string

├ └─href

Hyperlink para o Pedido.

link

└─payCheckout

Estrutura de link

structured

     └─redirectHref

Checkout Moip para que o usuário escolha a forma de pagamento: boleto ou cartão de crédito

link

└─payCreditCard

Estrutura de link

structured

     └─redirectHref

Checkout Moip para Cartão de crédito, ambiente seguro e em conformidade PCI Compliance.

link

└─payBoleto

Estrutura de link

structured

     └─redirectHref

Checkout Moip para exibição e impressão de boleto bancário.

link

└─payOnlineBankDebitItau

Estrutura de link

structured

     └─redirectHref

Redirecionamento automático para internet-banking Itaú.

link

Nos Multipagamentos existem algumas situações especiais. Fique atento a elas:

  • Se um pagamento em um carrinho for cancelado, cancelamos todos eles;
  • Se esse pagamento for o primeiro em um carrinho, nós não tentamos os demais;
  • Se esse pagamento for o último no carrinho, cancelamos os anteriores.

❗️

ATENÇÃO

A resposta de criação do multipagamento é assíncrona (via webhooks), a razão é que, a nossa regra considera que:

Se um carrinho tiver muitos pedidos, o adquirente pode demorar pra nos responder. Pra não segurar o checkout do cliente, damos uma resposta de aguardo. E depois notificamos o status assincronamente.