5. Pagamentos

O Pagamento é a transação financeira que ocorre entre o Cliente e o Recebedor, seja por meio de um cartão de crédito, de um boleto bancário, ou por outro meio de pagamento. Esta API permite a criação, consulta e listagem de pagamentos.

Atributos:

Nome

Descrição

Tipo

id

Código identificador do pagamento

string(16),
response

status

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

string,
response

amount

Valores do pedido.

structured,
response

├─refunds

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

integer(12),
response

├─fees

Valor total de tarifa Moip. Em centavos. Ex: R$10,32 será informado 1032

integer(12),
response

├─liquid

Valor líquido do pagamento. Em centavos. Ex: R$10,32 será informado 1032

integer(12),
response

├─currency

Moeda utilizada no pagamento. Valores possíveis: BRL.

string,
response

└─total

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

integer(12),
response

installmentCount

Número de parcelas. Mínimo 1 e máximo 12.

integer(2)

delayCapture

Se o pagamento deve ser pré-autorizado para captura posterior. Válido apenas para pagamentos por cartão de crédito.

boolean

statementDescriptor

Identificação de sua loja na fatura de cartão de crédito do comprador.

string(13)

fundingInstrument

Meio de pagamento utilizado.

structured

├─method

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

string

├─creditCard

Dados do cartão de crédito utilizado no pagamento.

object,
Obrigatório para o Venda Protegida

├ ├─hash

Dados criptografados do cartão de crédito. IMPORTANTE: você deve fazer a criptografia dos dados do cartão de crédito antes de enviar ao Moip caso seu site não tenha o certificado PCI.

string

├ ├─number

Número do cartão de crédito. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

string(19)

├ ├─expirationMonth

Mês de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer(2),
Obrigatório para o Venda Protegida

├ ├─expirationYear

Ano de expiração do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer(4),
Obrigatório para o Venda Protegida

├ ├─cvc

Código de segurança do cartão. (Necessário estar dentro do escopo PCI para enviar esse campo sem criptografia)

integer,
Obrigatório para o Venda Protegida

├ ├─id

Identificador do cartão de crédito no Moip.

string(16),
response

├ ├─brand

Bandeira do cartão. Valores possíveis: VISA, MASTERCARD, AMEX, DINERS, ELO, HIPER, HIPERCARD.

string,
response

├ ├─first6

Primeiros 6 dígitos do cartão.

string,
response

├ ├─last4

Últimos 4 dígitos do cartão.

string,
response

├ ├─holder

Portador do cartão.

structured,
obrigatório

├ ├ ├─store

Determina durante a criação de um pagamento se o cartão de crédito utilizado deve ser salvo para oneClickBuy (default: true).

boolean

├ ├ ├─fullname

Nome do portador impresso no cartão.

string(90),
obrigatório
Obrigatório para o Venda Protegida

├ ├ └─birthDate

Data de nascimento do cliente.

date(AAAA-MM-DD),
obrigatório *
Obrigatório para o Venda Protegida

├ ├─phone

Telefone do cliente.

structured

├ ├ ├─countryCode

DDI (código internacional) do telefone. Valores possíveis: 55.

integer(2)

├ ├ ├─areaCode

DDD (código local) do telefone.

integer(2)

├ ├ └─number

Número do telefone.

integer(9)

├ ├─taxDocument

Documento fiscal.

structured,
obrigatório
Obrigatório para o Venda Protegida

├ ├ ├─type

Tipo do documento. Valores possíveis: CPF ou CNPJ.

string(3),
obrigatório
Obrigatório para o Venda Protegida

├ ├ └─number

Número do documento.

string(11),
obrigatório
Obrigatório para o Venda Protegida

├ └─billingAddress

Endereços de cobrança do cartão de crédito.

object

├ ├─street

Logradouro do endereço.

string(140)

├ ├─streetNumber

Número.

string(10)

├ ├─complement

Complemento do endereço.

string(140)

├ ├─district

Bairro.

string(45)

├ ├─city

Cidade.

string(32)

├ ├─state

Estado.

string(32)

├ ├─country

País em formato ISO-alpha3, exemplo BRA.

string(3)

├ └─zipCode

O CEP do endereço de cobrança.

string(8)

├─boleto

Dados do boleto utilizado no pagamento.

structured

├ ├─lineCode

Linha digitável de um boleto.

string

├ ├─expirationDate

Data de expiração de um boleto.

date,
obrigatório

├ ├─instructionLines

Instruções impressas no boleto.

structured

├ ├ ├─first

Primeira linha de instrução.

string

├ ├ ├─second

Segunda linha de instrução. Para usar a segunda linha é obrigatório o uso da primeira linha de instrução (first).

string

├ ├ └─third

Terceira linha de instrução. Para usar a segunda linha é obrigatório o uso da segunda linha de instrução (second).

string

├ └─logoUri

Endereço de uma imagem com o logotipo a ser impresso no boleto.

string

├─onlineBankDebit

Dados da transferência bancária utilizada no pagamento.

object

├ ├─bankNumber

Número do banco. Exemplo de valor possível: 341.
Ver lista de Instituições bancárias

string,
obrigatório

├ ├─bankName

Nome do banco.

string,
response

├ ├─expirationDate

Data de expiração do débito.

date,
obrigatório

└ └─returnUri

Url de redirecionamento. Ainda não disponível nesta versão da API.

link,
obrigatório

fees

Tarifas do pagamento.

structured list,
response

├─type

Tipo de tarifa. Valores possíveis: TRANSACTION, PRE_PAYMENT.

string

└─amount

Valor da tarifa. Em centavos Ex: R$10,32 será informado 1032

integer(12)

events

Eventos associados ao pagamento.

structured list,
response

├─createdAt

Data de criação do evento.

date

├─type

Tipo do evento. Valores possíveis: PAYMENT.WAIING, PAYMENT.AUTHORIZED, PAYMENT.IN_ANALYSIS, PRE_AUTHORIZED, PAYMENT.REFUNDED, PAYMENT.REVERSED.

string

└─description

Descrição do evento.

string

cancellationDetails

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

structured

├─cancelledBy

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

string,
response

├─code

Código do motivo de cancelamento. Ver lista de Cancelamentos de pagamentos

number,
response

└─description

Descrição do motivo de cancelamento.

string,
response

updatedAt

Data da última atualização do recurso.

datetime,
response

createdAt

Data da criação do recurso.

datetime,
response

device

Informações sobre o dispositivo utilizado pelo comprador no momento do pagamento.

structured

├─ip

IP do comprador.

string(15)

├─userAgent

Informações do software utilizado pelo comprador, como sistema operacional e navegador.

string(256)

├─fingerprint

Fingerprint do device utilizado.

string(256)

├─geolocation

Referência para o Pedido.

structured

├ ├─latitude

Latitude da localização do comprador. Valores possíveis vão de -90 até 90, com 7 decimais (Caso o valor informado exceda o máximo, criaremos o pagamento com latitude 90).

decimal(9,7)

├ └─longitude

Longitude da localização do comprador. Valores possíveis vão de -180 até 180, com 7 decimais (Caso o valor informado exceda o máximo, criaremos o pagamento com longitude 180).

decimal(10,7)

├─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

└─checkout

Links para checkout. Apenas será retornado o link para o meio de pagamento escolhido.

object

_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

❗️

Venda Protegida

Os atributos destacados com Venda Protegida são campos obrigatórios para ser elegível no programa.

🚧

IMPORTANTE

O valor pago em um boleto pode ser diferente do valor inicial do pedido. Sempre valide o atributo amount.total, enviados nos webhooks de pagamentos e também disponível nas consultas via API.