Webhook

Nossa API de POSTs automatiza o controle dos seus produtos e otimiza a entrega para o cliente, além de
poder ser integrada a qualquer sistema.

Documentação
Nossa API de POSTS automatiza o controle dos seus produtos e otimiza a entrega para o cliente, além de
poder ser integrada a qualquer sistema. Para criar esta integração, é necessário conhecimento em
programação.

Todos os parâmetros são enviados para o Produtor.

O webhook do My Checkout espera que sua aplicação responda uma mensagem com no máximo 5000
caracteres.

Eventos de pedido
Formato de envio dos dados: QUERYSTRING

Enviado
Nome do parâmetro Descrição Formato e tamanho
para afiliado

Cada conta possui um

hottok único e essa é a
hottok Números e letras de até 255
Sim principal garantia de
caracteres
que o post está sendo
feito pelo My Checkout

prod Somente números com até 20

Sim Código do produto que
dígitos
foi adquirido

prod_name Nome do produto que Números e letras de até 255

Sim
foi adquirido caracteres

off Código da oferta que foi Números e letras de até 255

Não
adquirida caracteres

price Preço da oferta no Número decimal de 0.01 até

Não
momento da compra 9999999999999999999.99
 Código de afiliado do
aff Números e letras de até 255
Sim usuário que indicou a
caracteres
venda do produto

Nome do usuário que

aff_name Números e letras de até 255
Sim indicou a venda do
caracteres
produto

email Números e letras de até 255

Não E-mail do comprador
caracteres

name Nome completo do Números e letras de até 255

Não
comprador caracteres

first_name Primeiro nome do Números e letras de até 255

Não
comprador caracteres

last_name Sobrenome do Números e letras de até 255

Não
comprador caracteres

CPF da pessoa ou Números e letras de até 20

doc Não documento usado do caracteres
comprador Ex: 999999999999999

DDD do telefone do Somente números com até 20

phone_local_code Não comprador cadastrado dígitos
na plataforma Ex: 99

Número do telefone do Somente números com até 20

phone_number Não comprador cadastrado dígitos
na plataforma Ex: 99

DDD do telefone do Somente números com até 20

phone_checkout_local_c
ode Não comprador preenchido dígitos
na tela de checkout Ex: 99

Número do telefone do Somente números com até 20

phone_checkout_number Não comprador preenchido dígitos
na tela de checkout Ex: 99
address Números e letras de até 255
Não Endereço do comprador
caracteres

address_number Número do endereço do Números e letras de até 255

Não
comprador caracteres

address_country País do comprador do Números e letras de até 255

Não
comprador caracteres

address_district Números e letras de até 255

Não Bairro do comprador
caracteres

address_comp Complemento do Números e letras de até 255

Não
endereço do comprador caracteres

address_city Números e letras de até 255

Não Cidade do comprador
caracteres

address_state Números e letras de até 255

Não Estado do comprador
caracteres

address_zip_code Números e letras de até 255

Não CEP do comprador
caracteres

transaction Números e letras de até 255

Sim Código da transação
caracteres

Código customizado
pelo usuário. Pode ser
xcod Números e letras de até 255
Sim definido no link de
caracteres
venda para ser recebido
de volta
Código customizado
pelo usuário. Pode ser
src Números e letras de até 255
Sim definido no link de
caracteres
venda para ser recebido
de volta

Possíveis valores: approved,

canceled, billet_printed, refunded,
status Sim Status da compra dispute, completed, blocked,
chargeback, delayed, expired,
wayting_payment
 Quem processou a
payment_engine Possíveis valores: ' mycheckout ',
Sim compra (Moip ou
'bcash','monthly', 'paypal','moip'
PayPal)

Possíveis valores: 'billet',

'credit_card', 'debit_card',
payment_type Forma de pagamento 'bank_transfer', 'moip_balance',
Sim
do comprador 'bcash_balance',
'paypal','order.checkout.mycheck
out_balance'

Enviado apenas no
caso de Sites de
Membros (venda de
hotkey acesso a conteúdo Números e letras de até 255
Não
restrito). Trata-se do caracteres
número de série único
liberado para aquele
comprador
Enviado apenas em
caso de venda de
name_subscription_plan Números e letras de até 255
Não assinaturas. Trata-se do
caracteres
nome do plano
adquirido

subscriber_code Números e letras de até 50

Não Código do assinante
caracteres

O campo
recurrency_period é
enviado sempre que a
compra é do tipo
assinatura e ele é enviado
para notificação de
compra e cancelamento.
Os valores possíveis para
este campo são 7, 30, 60,
90, 180 e 360 e esses
valores representam a
recurrency_period Somente números com até 11
Não periodicidade em dias do
pagamento da respectiva dígitos
assinatura. O
preenchimento desse
campo leva em
consideração o status da
assinatura que é enviado
no campo
'subscription_status' e os
valores possíveis são
active, inactive, past_due,
canceled, expired e started
 Período do pagamento Somente números com até 11
recurrency Não em que o assinante dígitos
atualmente está Ex: 1, 2, 3, 4, ...

Tarifa de intermediação
cms_marketplace Número decimal de 0.01 até
Não e processamento do
9999999999999999999.99
pagamento

cms_vendor Comissão do produtor Número decimal de 0.01 até

Não
gerada nesta transação 9999999999999999999.99

cms_aff Comissão do Afiliado Número decimal de 0.01 até

Sim
gerada nesta transação 9999999999999999999.99

Enviado apenas caso

coupon_code Números e letras de até 25
Sim um cupom tenha sido
caracteres
utilizado na compra

Tipo do callback: 1 -
callback_type compra pagamento
Sim Possíveis valores: 1 e 2
único; 2 - cancelamento
assinatura

Status da assinatura
subscription_status (active, canceled, Números e letras de até 255
Não
past_due, expired, caracteres
started, inactive)

Código de transação
transaction_ext gerado pelo meio de Números e letras de até 255
Sim
pagamento externo caracteres
(BCash, PayPal, etc)
Código de até 6
caracteres. Pode ser
customizado pelo
sck Números e letras de até 255
Não usuário para rastrear
caracteres
origens das vendas
realizadas em seus
checkouts

purchase_date Data
Sim Data do pedido
Ex: 1970-04-01T12:50:30Z
confirmation_purchase_ Data de liberação da Data
date Sim
compra Ex: 1970-04-01T12:50:30Z

Link para reimprimir o

boleto da compra (só é
billet_url Números e letras de até 5000
Não enviado caso a compra
caracteres
seja do tipo boleto
bancário)

Números e letras de até 3

currency_code_from Moeda utilizada
Sim caracteres
originalmente na oferta
Ex: BRL

original_offer_price Valor original do Número decimal de 0.01 até

Sim
produto 9999999999999999999.99

Números e letras de até 3

currency Sim Descrição da moeda caracteres
Ex: R$, €, US$

Possíveis valores: 'Active',

'Inactive', 'Delayed', 'Canceled by
signature_status Sim Status da assinatura client', 'Canceled by vendor',
'Canceled by admin', 'Expired',
'Started'

Código de barra do
boleto para o
billet_barcode pagamento da compra Números e letras de até 255
Não
(só é enviado caso a caracteres
compra seja do tipo
boleto bancário)

producer_name Números e letras de até 255

Sim Nome do produtor
caracteres

producer_document Documento de Números e letras de até 20

Sim
identidade do produtor caracteres

producer_legal_nature Natureza jurídica do Números e letras de até 20

Sim
produtor caracteres
 Origem da moeda Números e letras de até 3
currency_code_from_ Sim utilizada no pagamento caracteres
da compra Ex: BRL, ARG, USA

Texto de recusa do
refusal_reason Números e letras de até 500
Sim pagamento pela
caracteres
operadora

Números e letras de até 255

Tipo de documento, que caracteres
varia de acordo com a Ex: CPF ou CNPJ para
doc_type Não nacionalidade e compradores brasileiros; DNI ou
natureza jurídica do CIF para espanhóis e
comprador DOCUMENT para os demais
países

full_price Número decimal de 0.01 até

Não Valor total da compra
9999999999999999999.99

Data de vencimento da
warranty_date Data
Sim garantia do produto
Ex: 1970-04-01T12:50:30Z
adquirido

Lista de moedas que Números e letras de até 3

cms_aff_currency Sim serão pagas as caracteres
comissões dos afiliados Ex: BRL, ARG, USA

product_support_email E-mail de suporte do Números e letras de até 255

Sim
produto caracteres

amount Quantidade de e-tickets Somente números com até 20

Não
na venda dígitos

Números e letras de até 3

aff_cms_rate_currency Sim Moeda de conversão caracteres
Ex: BRL

aff_cms_rate_commissio Valor da comissão Número decimal de 0.01 até

n Sim
convertida 9999999999999999999.99
aff_cms_rate_conversio Taxa utilizada no Número decimal de 0.01 até
n Sim
momento da conversão 9999999999999999999.99

installments_number Sim Número de parcelas Número de 1 até 12

Verdadeiro se produto
has_co_production Não adquirido possui Booleano (true ou false)
coprodutor

Possíveis valores:
productOfferPaymentMod Tipo de pagamento da 'pagamento_unico',
e Sim
oferta que foi adquirida 'multiplos_pagamentos','pagamen
to_vista'

Tipo do usuário receptor

receiver_type Possíveis valores: 'SELLER',
Sim do evento gerado pelo
'AFFILIATE'
webhook

subscription_date_next Data da próxima Data

_charge Não
cobrança Ex: 1970-04-01T12:50:30Z

Evento de abandono de carrinho

Formato de envio dos dados: JSON

Enviado
Formato e
Nome do parâmetro para Descrição
tamanho
afiliado

affiliate Verdadeiro se a origem do pedido é de um Booleano (true ou

Não
afiliado false)

Cada conta possui um hottok único e essa é Números e letras

hottok Não a principal garantia de que o post está de até 255
sendo feito pelo My Checkout caracteres