Gravity PayDocs
Referência da API

Criar cobrança

POST /v1/charges

POST /v1/charges

Cria uma cobrança avulsa e devolve uma checkoutUrl para o cliente pagar.

Autenticação: Authorization: Bearer <api_key>

Corpo (JSON)

CampoTipoObrigatórioDescrição
currencystringsimISO 4217, 3 letras (usd, brl).
items[]array—¹{ name: string, quantity: int, unitAmountInCents: int }.
amountInCentsinteger—¹Total em centavos. Use quando não enviar items.
customerobject{ email?: string, name?: string }.
descriptionstringAté 255 caracteres.
metadataobjectPares chave/valor. Retornam nos webhooks.
postbackUrlstringURL (https) para os webhooks desta cobrança.
successUrlstringRedirecionamento após o pagamento.
cancelUrlstringRedirecionamento ao cancelar.

¹ Envie items ou amountInCents (pelo menos um, com total > 0).

Resposta 201

CampoTipoDescrição
idstringId da cobrança (chg_…).
statusstringpending na criação.
amountInCentsintegerTotal calculado.
currencystringMoeda.
itemsarrayItens enviados.
checkoutUrlstringURL do checkout — leve o cliente até ela.
postbackSecretstringSó aqui. Valida os webhooks do postbackUrl.
metadataobjectSua metadata.

Erros

400 — requisição inválida
{ "error": { "type": "invalid_request", "message": "Informe `items` ou um `amountInCents` maior que zero.", "param": "items" } }
401 — não autenticado
{ "error": { "type": "authentication", "message": "Chave de API inválida." } }