Pular para o conteúdo principal

Criar assinatura sem cartão

POST/api/v1/subscriptions/

Sem nenhuma forma de cartão. As validações da seção Criar assinatura com cartão valem igual.

{
"value": 1990,
"cycle": "MONTHLY",
"nextDueDate": "2026-10-15",
"payerName": "Maria Oliveira",
"payerDocument": "52998224725",
"payerEmail": "[email protected]",
"callbackUrl": "https://meu-sistema.com/webhook/subscription"
}
Resposta 201
{
"status": "success",
"data": {
"id": 9,
"merchantId": 2,
"status": 3,
"value": 1990,
"amount": 19.9,
"cycle": "MONTHLY",
"nextDueDate": "2026-10-15",
"endDate": null,
"payerName": "Maria Oliveira",
"payerDocument": "52998224725",
"payerEmail": "[email protected]",
"cardLastFour": "",
"cardBrand": "",
"cardExp": "",
"callbackUrl": "https://meu-sistema.com/webhook/subscription",
"paymentGuid": "1da43ec5-306e-44a9-8870-da557a0f41a9",
"paymentUrl": "https://plataforma.yumepayhml.com.br/subscription-checkout/1da43ec5-306e-44a9-8870-da557a0f41a9/",
"lastChargeStatus": null,
"lastChargeAt": null,
"consecutiveDeniedCharges": 0,
"createdAt": "2026-10-09T12:30:11Z",
"updatedAt": "2026-10-09T12:30:11Z"
}
}
CampoDescrição
status: 3PENDING_PAYMENT — aguardando o pagador informar o cartão
paymentUrlURL para enviar ao pagador. A YumePay não a envia (Escopo da plataforma)
paymentGuidIdentificador do checkout, usado nas rotas da seção Ativar a assinatura pelo seu próprio checkout

O fluxo completo, passo a passo​

PassoQuemO que acontece
1Seu sistemaPOST /api/v1/subscriptions/ sem cartão.
2YumePay201 com paymentUrl e status PENDING_PAYMENT.
3Seu sistemaEnvia a paymentUrl ao pagador. Enquanto ele não paga, você pode corrigir valor, ciclo, datas e descrição (Atualizar assinatura) sem invalidar a URL.
4PagadorAcessa a página e informa o cartão.
5YumePayTokeniza, muda para ACTIVE e cobra na hora se o vencimento for hoje.
6YumePayDispara o webhook de cobrança, se houver callbackUrl.

Se o pagador demorar e o vencimento passar, a assinatura é cobrada uma vez no processamento seguinte à ativação e segue para o próximo vencimento futuro (Processamento das cobranças).