curl --request POST \
  --url https://api.sandbox.gravitypay.app/v1/charges/{id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "pix",
  "buyer": {
    "name": "Maria da Silva",
    "email": "maria@exemplo.com",
    "document": "529.982.247-25",
    "phone": "(11) 99999-9999"
  },
  "metadata": {
    "pedido": "A-1"
  }
}
'

{
  "object": "payment",
  "id": "<string>",
  "chargeId": "<string>",
  "status": "pending",
  "method": "pix",
  "provider": "ASAAS",
  "amountInCents": 123,
  "totalInCents": 123,
  "installments": 123,
  "pix": {
    "copyPaste": "<string>",
    "qrCodeBase64": "<string>",
    "qrCodeUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "boleto": {
    "line": "<string>",
    "barcode": "<string>",
    "url": "<string>",
    "pdfUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z"
}

Cobranças

Pagar cobrança (pagamento transparente)

Cria o pagamento de uma cobrança da loja da chave sem tirar o comprador do seu site: PIX (copia-e-cola e QR), boleto (linha digitável e PDF) ou cartão.

O gateway é decidido pela Gravity Play, pela mesma regra do checkout hospedado (veja GET /v1/payment-methods); taxa da plataforma, split, parcelamento, e-mails e webhooks são os mesmos. O cartão vai aberto só quando o gateway de cartão da loja é Asaas (card.input = raw); Pagar.me e Efí recebem card.token, gerado no navegador; Stripe só pelo checkout hospedado.

Já existindo um PIX (com mais de 5 minutos de validade) ou boleto (dentro do vencimento) pendente do mesmo método nesta cobrança, ele é devolvido de novo com 200, sem gerar outro. Duas chamadas simultâneas para a mesma cobrança: uma é atendida e a outra recebe 409 payment_in_progress.

O IP do comprador vem de buyer.ip (obrigatório no cartão Asaas), nunca do IP da requisição.

Escopo exigido: charges:write.

POST

/

v1

/

charges

/

{id}

/

payments

curl --request POST \
  --url https://api.sandbox.gravitypay.app/v1/charges/{id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "pix",
  "buyer": {
    "name": "Maria da Silva",
    "email": "maria@exemplo.com",
    "document": "529.982.247-25",
    "phone": "(11) 99999-9999"
  },
  "metadata": {
    "pedido": "A-1"
  }
}
'

{
  "object": "payment",
  "id": "<string>",
  "chargeId": "<string>",
  "status": "pending",
  "method": "pix",
  "provider": "ASAAS",
  "amountInCents": 123,
  "totalInCents": 123,
  "installments": 123,
  "pix": {
    "copyPaste": "<string>",
    "qrCodeBase64": "<string>",
    "qrCodeUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "boleto": {
    "line": "<string>",
    "barcode": "<string>",
    "url": "<string>",
    "pdfUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id

string

required

Body

application/json

Pagamento da API transparente. Além do schema, cada gateway exige: Asaas — PIX/boleto: nome, e-mail, documento e telefone; cartão: também buyer.ip, buyer.address.zipCode/number e o cartão aberto. Pagar.me — PIX: nome, e-mail, documento e telefone; boleto e cartão: também o endereço completo (CEP, rua, número, cidade, UF); cartão: card.token. Efí — só cartão, com card.token. Faltando, 400 com param.

method

enum<string>

required

Available options:

pix,

boleto,

credit_card

buyer

object

required

Show child attributes

installments

integer

Só no cartão; até o maxInstallments da cobrança.

Required range: 1 <= x <= 12

boletoDueInDays

integer

Vencimento deste boleto, em dias. Vence o boletoDueInDays da cobrança e o padrão da loja.

Required range: 1 <= x <= 60

card

object

Cartão aberto (number, holderName, expiryMonth, expiryYear, cvv) só em loja Asaas; token (e threedsTransactionId, Pagar.me 3DS, opcional) em Pagar.me e Efí.

Show child attributes

metadata

object

Vai para o pagamento (metadata dos webhooks payment.* dos endpoints do painel).

Show child attributes

Response

PIX ou boleto pendente reaproveitado (nenhum gateway chamado).

object

string

required

Example:

"payment"

id

string

required

Id do pagamento na Gravity Play: o mesmo data.id dos webhooks payment.*.

chargeId

string

required

status

enum<string>

required

failed cobre recusa e PIX vencido.

Available options:

pending,

paid,

failed,

refunded

method

enum<string>

required

Available options:

pix,

boleto,

credit_card

provider

enum<string>

required

Available options:

ASAAS,

PAGARME,

EFI

amountInCents

integer

required

Valor da cobrança.

totalInCents

integer

required

Valor cobrado, com o juro do parcelamento quando o comprador paga.

installments

integer

required

pix

object | null

required

Show child attributes

boleto

object | null

required

Show child attributes

createdAt

string<date-time>

required