4. Pedidos

O Pedido é a representação da venda de um produto ou serviço. Esta API possibilita a criação, consulta e listagem de pedidos.

Atributos Request (requisição)

Nome, descrição e detalhes

ownId

Id próprio do pedido. Referência externa.

String (45),
obrigatório
Obrigatório para o Venda Protegida.

amount

Valores do pedido.

Structured

├─currency

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

String (3),
obrigatório

├─subtotals

Estrutura de valores adicionais do pedido.

Structured

├ ├─shipping

Valor de frete do item, será somado ao valor dos itens. Em centavos Ex: R$10,32 deve ser informado 1032

Integer (9),
obrigatório

├ ├─addition

Valor adicional ao item, será somado ao valor dos itens. Em centavos Ex: R$10,32 deve ser informado 1032

Integer (9)

├ ├─discount

Valor de desconto do item, será subtraído do valor total dos itens. Em centavos Ex: R$10,32 deve ser informado 1032

Integer(9)

items

Estrutura de informações do item do pedido.

Structured list

├─product

Nome do produto.

String (250),
obrigatório
Obrigatório para o Venda Protegida.

├─category

Categoria do produto. Ver a seção Categorias de Produtos.

string(256)

├─quantity

Quantidade de produtos.

integer(12),
Obrigatório para o Venda Protegida.

├─detail

Descrição adicional do produto.

String
Obrigatório para o Venda Protegida.

└─price

Valor inicial do item. (O valor será multiplicado de acordo com a quantidade de produtos.) Em centavos Ex: R$10,32 deve ser informado 1032

Integer (8),
obrigatório
Obrigatório para o Venda Protegida.

checkoutPreferences

Configurações para o checkout Moip.

Structured

├─redirectUrls

URLs de redirecionamento.

String (256)

├ ├─urlSuccess

URL para redirecionamento em casos de sucesso.

String (256)

└ └─urlFailure

URL para redirecionamento em casos de falha.

String (256)

├─installments

Configurações de parcelamento.

Structured list

├ ├─quantity

Limitadores do plano de parcelas. Exemplo: [1, 3];

Tupla

├ ├─discount

Valor de desconto para a parcela.

Integer (9)

└ └─addition

Valor de acréscimo para a parcela.

Integer (9)

shippingAddress

Endereço de entrega.

structured object,
obrigatório

├─street

Logradouro do endereço.

String,
obrigatório

├─streetNumber

Número.

String,
obrigatório

├─complement

Complemento do endereço.

String

├─district

Bairro.

String,
obrigatório

├─city

Cidade.

String
obrigatório

├─state

Estado.

String (32),
obrigatório

├─country

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

String (3),
obrigatório

├─zipCode

O CEP do endereço de cobrança.

String (20),
obrigatório

customer

Cliente associado ao pedido. Você pode criar um pedido com cliente já existente ou com novo cliente.

Structured object

receivers

Estrutura de recebedores dos pagamentos.

Structured list

├─type

Define qual o tipo de recebedor do pagamento, valores possíveis: PRIMARY, SECONDARY

String

├─feePayor

Boolean para definir se o recebedor é o pagador da taxa Moip, valores possíveis: true, false. Se o feePayor não for informado, o recebedor type PRIMARY será o pagador da taxa Moip. Se houver mais de um recebedor tipo SECONDARY, apenas um deles poderá ser o pagador da taxa.

Boolean

├─moipAccount

Boolean

Structured

├ ├─login

Login Moip ao qual recebeu valores do pagamento.

String (256)

├ ├─fullname

Nome do portador da Conta do Moip.

String (256)

├ └─id

Id Moip da Conta da Moip que irá receber valores do pagamento.

String (16)

├─amount

Estrutura de valor a ser recebido

Structured

├ ├─refunds

Structured

integer(12)

├ ├─fees

Valor total de tarifas pagas pelo recebedor.

integer(12)

└ └─total

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

integer(12)

Atributos Response (resposta/callback)

Nome

Descrição

Tipo

id

Código identificador do pedido.

string(16)

status

Status do pedido. Valores possíveis: CREATED, WAITING, PAID, NOT_PAID, REVERTED.

string

createdAt

Data de criação do recurso.

datetime

amount

Valores do pedido.

structured

├─total

Valor total do pedido, em centavos. Ex: R$10,32 deve ser informado 1032.

integer(12)

├─fees

Valor total de tarifa Moip.

integer(12)

├─refunds

Valor total de reembolsos.

integer(12)

├─liquid

Valor total liquido.

integer(12)

├─otherReceivers

Soma de valores recebidos por outros recebedores. Usado em Marketplaces.

integer(12)

├─subtotals

Estrutura de valores adicionais do pedido.

structured

└ └─items

Soma dos valores de todos os itens.

integer(12)

payments

Pagamentos associados ao pedido. Ver recurso Pagamentos para mais informações.

coleção de Pagamentos

refunds

Reembolsos associados ao pedido. Ver recurso Reembolso para mais informações.

coleção de Reembolsos

entries

Lançamentos associados ao pedido. Ver objeto Lançamentos para mais informações.

coleção de Lançamentos

events

Eventos associados ao pedido

structured list

.

├─createdAt

Data de criação do evento.

date(AAAA-MM-DD)

├─type

Tipo do evento. Valores possíveis: ORDER.CREATED, ORDER.WAITING, ORDER.PAID, ORDER.NOT_PAID, ORDER.REVERTED.

string

└─description

Descrição do evento.

string(65)

`updatedAt

Data da última atualização do recurso.

datetime

_links

Estrutura de links Hypermedia (HATEOAS) do recurso.

structured

├─self

Hyperlink para o próprio recurso.

structured

├ └─href

Hyperlink para o próprio recurso.

link

└─checkout

Links para checkout.

object

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