PayZu GatewayCheckoutPlano e adesão

Criar uma assinatura pela página

POST/v1/checkout/subscriptions

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/subscribe-to-a-plan


Body Params

payment_methodstring enumobrigatório
Meio de pagamento da assinatura.credit_cardpix
customerobjectobrigatório
Dados de quem assina.
plan_idstringobrigatório
ID do plano.

Headers

x-checkout-keystringobrigatório
Chave de checkout.
acceptstring
Formato da resposta.

Responses

201Assinatura criada
idstringID da assinatura.
codestringCódigo curto da assinatura.
statusstringStatus da assinatura.
activecanceledincomplete
namestringNome da assinatura.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
payment_methodstringMeio de pagamento.
credit_cardpix
recurrence_modestringnative: a adquirente cobra cada ciclo no cartão; manual: cada ciclo gera uma fatura para pagar.
nativemanual
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
recurrence_end_datestring | nullData final da recorrência; nula se não termina.
credit_cardobject | nullCartão da assinatura; nulo no Pix.
Campos do objeto 1
cardobjectCartão.
Campos do objeto 4
idstringID do cartão salvo.
last_digitsstringÚltimos 4 dígitos.
expirationstring | nullValidade do cartão.
holder_namestring | nullNome impresso no cartão.
billingobjectCiclos de cobrança.
Campos do objeto 3
anchor_atstringData de referência dos ciclos.
next_atstring | nullData do próximo ciclo; nula na assinatura cancelada.
canceled_atstring | nullData e hora do cancelamento.
graceobject | nullCarência depois de um ciclo sem pagamento; nula sem carência.
Campos do objeto 1
ends_atstring | nullFim da carência: o limite para pagar a fatura do ciclo.
cancellationobject | nullCancelamento; nulo se a assinatura não está cancelada.
Campos do objeto 1
reasonstring | nullMotivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestother
customerobjectQuem assina.
Campos do objeto 6
idstringID do cliente.
namestringNome do cliente.
emailstringE-mail do cliente.
phonestring | nullCelular do cliente.
documentstringCPF ou CNPJ do cliente.
document_typestringTipo do documento.
cpfcnpj
planobject | nullPlano da assinatura.
Campos do objeto 7
idstringID do plano.
namestringNome do plano.
descriptionstringDescrição do plano.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
payment_settingsobjectComo as assinaturas do plano podem ser pagas.
Campos do objeto 1
accepted_methodsarray of stringsMeios de pagamento aceitos.
credit_cardpix
checkoutobjectPágina de adesão do plano.
Campos do objeto 3
slugstring | nullSlug do plano na url da página.
logo_urlstring | nullLogotipo exibido na página.
redirect_urlstring | nullPara onde o cliente vai depois de pagar a adesão.
discountobject | nullDesconto dos primeiros ciclos, contando a adesão; nulo sem desconto.
Campos do objeto 4
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerCiclos com desconto, contando a adesão.
public_descriptionstring | nullTexto do desconto para o cliente.
invoiceobjectFatura de adesão, para pagar na url dela.
Campos do objeto 17
idstringID da fatura.
statusstringStatus da fatura.
pendingpaidcanceledexpiredrefundedchargedback
urlstringPágina da fatura, para o cliente pagar; paga, ela é o comprovante.
descriptionstringDescrição da fatura.
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
amountsobjectValores da fatura, em centavos.
Campos do objeto 5
subtotalintegerValor antes do desconto.
discountintegerDesconto aplicado.
totalintegerValor a pagar: o subtotal menos o desconto.
paidintegerTudo o que entrou, inclusive o pagamento em duplicidade.
refundedintegerTudo o que foi devolvido.
billingobjectPrazos e datas da fatura.
Campos do objeto 7
cycle_numberinteger | nullCiclo da assinatura, com a adesão no ciclo 0; nulo fora de assinatura.
due_atstringVencimento.
expires_atstringLimite para pagar.
paid_atstring | nullData e hora do pagamento.
canceled_atstring | nullData e hora do cancelamento.
refunded_atstring | nullData e hora do estorno.
chargedback_atstring | nullData e hora da contestação.
itemsarray of objectsItens da fatura.
Campos de cada item 4
namestringNome do item.
skustring | nullSeu código do item.
quantityintegerQuantidade.
unit_priceintegerPreço unitário, em centavos.
payment_settingsobjectComo a fatura pode ser paga.
Campos do objeto 2
accepted_methodsarray of stringsMeios aceitos.
credit_cardpix
credit_cardobject | nullRegras do cartão; nulo sem cartão.
Campos do objeto 1
max_installmentsintegerMáximo de parcelas no cartão.
checkoutobjectPara onde a página da fatura leva o cliente.
Campos do objeto 2
redirect_urlstring | nullPara onde o cliente vai depois de pagar.
cancel_urlstring | nullPara onde vai quem desiste.
merchantobjectQuem recebe o pagamento.
Campos do objeto 1
display_namestring | nullNome de exibição da conta, definido no painel do PayZu Gateway; nulo enquanto não há nome.
customerobject | nullCliente, com e-mail, documento e celular mascarados; nulo na fatura sem cliente.
Campos do objeto 6
namestringNome do cliente.
emailstringE-mail do cliente, mascarado.
documentstringCPF ou CNPJ do cliente, mascarado.
document_typestringTipo do documento.
cpfcnpj
phonestring | nullCelular do cliente, mascarado.
address_on_filebooleanIndica se o cliente já tem endereço no cadastro; sem ele, o cartão leva address.
subscriptionobject | nullAssinatura da fatura; nula fora de assinatura.
Campos do objeto 2
codestringCódigo curto da assinatura.
namestringNome da assinatura.
payment_linkobject | nullLink de pagamento da compra; nulo fora de link.
Campos do objeto 3
idstringID do link.
namestringNome do link.
discountobject | nullDesconto do link; nulo sem desconto.
Campos do objeto 4
payment_methodstringMeio de pagamento com desconto.
credit_cardpix
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
public_descriptionstring | nullTexto do desconto para o cliente.
paymentsarray of objectsTentativas de pagamento, da mais nova para a mais antiga.
Campos de cada item 10
idstringID da tentativa.
statusstringStatus da tentativa.
pendingprocessingpaidfailedexpiredrefund_requestedrefundedchargedback
methodstringMeio de pagamento.
credit_cardpix
amountintegerValor da tentativa, em centavos.
created_atstringData e hora da tentativa.
paid_atstring | nullData e hora do pagamento.
failed_atstring | nullData e hora da recusa.
failureobject | nullMotivo da recusa; nulo fora de failed.
Campos do objeto 3
stagestringEtapa que recusou.
issuerantifraudcard_checksplitprocessing
codestringCódigo da recusa.
messagestringMotivo da recusa, para mostrar ao cliente.
credit_cardobjectDados do cartão; nulo no Pix.
Campos do objeto 3
installmentsinteger | nullParcelas.
authorization_codestring | nullCódigo de autorização; nulo sem aprovação.
cardobject | nullCartão.
Campos do objeto 2
brandstring | nullBandeira.
last_digitsstringÚltimos 4 dígitos.
pixobjectDados do Pix; nulo no cartão.
Campos do objeto 4
qr_code_textstring | nullPix copia e cola.
qr_code_urlstring | nullSempre nulo: monte o QR Code com qr_code_text.
expires_atstring | nullQuando o QR Code vence.
end_to_end_idstring | nullID do Pix no Banco Central; nulo até o pagamento.
refundsarray of objectsEstornos, do mais novo para o mais antigo.
Campos de cada item 4
statusstringStatus do estorno.
requestedconfirmedfailed
amountintegerValor estornado, em centavos.
requested_atstring | nullData e hora do pedido.
confirmed_atstring | nullData e hora da confirmação.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
fieldsarray of objectsCampos recusados na validação.
Campos de cada item 2
namestringCaminho do campo recusado.
messagestringMotivo da recusa.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
404Não encontrado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
409Conflito
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
422Operação recusada
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
429Limite por IP
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.

Linguagem

Credenciais API Key

Chave de checkout

curl --request POST \     --url https://api.sandbox.payzu.dev/v1/checkout/subscriptions \     --header 'x-checkout-key: SUA_CHAVE_DE_CHECKOUT' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json