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",
"callbackUrl": "https://meu-sistema.com/webhook/subscription"
}
{
"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",
"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"
}
}
| Campo | Descrição |
|---|---|
status: 3 | PENDING_PAYMENT — aguardando o pagador informar o cartão |
paymentUrl | URL para enviar ao pagador. A YumePay não a envia (Escopo da plataforma) |
paymentGuid | Identificador do checkout, usado nas rotas da seção Ativar a assinatura pelo seu próprio checkout |
O fluxo completo, passo a passo
| Passo | Quem | O que acontece |
|---|---|---|
| 1 | Seu sistema | POST /api/v1/subscriptions/ sem cartão. |
| 2 | YumePay | 201 com paymentUrl e status PENDING_PAYMENT. |
| 3 | Seu sistema | Envia a paymentUrl ao pagador. Enquanto ele não paga, você pode corrigir valor, ciclo, datas e descrição (Atualizar assinatura) sem invalidar a URL. |
| 4 | Pagador | Acessa a página e informa o cartão. |
| 5 | YumePay | Tokeniza, muda para ACTIVE e cobra na hora se o vencimento for hoje. |
| 6 | YumePay | Dispara 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).