Em breve · Assinaturas
Criar assinatura Pix Automático
POST/v1/subscriptionssubscriptions:writeEM BREVE
O cliente autoriza uma vez no banco e as cobranças seguintes acontecem sozinhas.
Este recurso ainda não está disponível. O contrato abaixo mostra como ele vai funcionar, para você planejar a integração. Hoje a chamada é recusada e nada é criado; os campos podem mudar até a liberação, que sai no changelog.
Cabeçalhos
Authorizationstringobrigatório
Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.
Idempotency-Keystring · 8–128obrigatório
Corpo da requisição
external_idstring · 1–128obrigatório
product_iduuidobrigatório
frequencystringobrigatório
WEEKLYMONTHLYQUARTERLYSEMIANNUALLYANNUALLY
charge_dayinteger · 1–28opcional
Dia do mês da cobrança, para frequências mensais ou maiores.
customerobjectobrigatório
Titular que autoriza no banco. CPF ou CNPJ obrigatório.
3 campos
namestring · 2–120opcional
emailstringopcional
documentstringopcional
CPF ou CNPJ só com dígitos. Volta mascarado nas respostas.
metadataobject · até 20 chavesopcional
Pares chave-valor seus, até 2 KB.
Resposta 201
Sucesso.
iduuid
external_idstring
product_iduuid
frequencystring
authorization_statusstring
PENDINGACTIVECANCELEDREJECTED
amount_centsinteger
exemplo 4990 = R$ 49,90cycles_paidinteger
next_charge_datedate | null
first_paymentobject | null
QR da primeira cobrança, que também pede a autorização no banco.
2 campos
copy_pastestring
qr_code_base64string | null
cyclesobject[]
6 campos
cycleinteger
statusstring
SCHEDULEDPAIDFAILEDCANCELED
amount_centsinteger
due_datedate
paid_atdatetime | null
Pagamento do ciclo.
end_to_end_idstring | null
metadataobject · até 20 chaves
Pares chave-valor seus, até 2 KB.
authorized_atdatetime | null
Autorização no banco.
canceled_atdatetime | null
Cancelamento.
created_atdatetime
Códigos de resposta
| HTTP | Quando acontece |
|---|---|
| 201 | Sucesso. |