Skip to main content
POST
/
billings
/
create
curl -X POST 'https://api.goatpay.com.br/v1/billings/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "salesCustomerId": "clx_customer", "billingType": "BOLETO", "amount": 79.9, "description": "Pedido 123", "dueDate": "2026-08-15", "installmentCount": 1, "externalReference": "pedido-123" }'

{
  "success": true,
  "message": "Cobrança avulsa criada",
  "data": {
    "id": "clx_billing",
    "status": "PENDING",
    "statusLabel": "Pendente",
    "billingType": "PIX",
    "amount": 79.9,
    "netAmount": 76.91,
    "feeAmount": 2.99,
    "notificationFeeAmount": 0,
    "installmentCount": 1,
    "description": "Pedido 123",
    "dueAt": "2026-06-15T23:59:59.000Z",
    "dueDate": "2026-06-15",
    "paidAt": "2026-05-31T14:22:00.000Z",
    "estimatedCreditDate": "2026-06-02T00:00:00.000Z",
    "invoiceUrl": "https://...",
    "bankSlipUrl": null,
    "digitableLine": null,
    "pixCopyPaste": "00020101021226730014br.gov.bcb.pix...",
    "pixEncodedImage": "iVBORw0KGgo...",
    "accountTransactionId": "clx_ledger",
    "externalReference": "pedido-123",
    "createdAt": "2026-05-30T10:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Cliente Exemplo",
      "taxId": "12345678909"
    }
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/billings/create' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{ "salesCustomerId": "clx_customer", "billingType": "BOLETO", "amount": 79.9, "description": "Pedido 123", "dueDate": "2026-08-15", "installmentCount": 1, "externalReference": "pedido-123" }'

{
  "success": true,
  "message": "Cobrança avulsa criada",
  "data": {
    "id": "clx_billing",
    "status": "PENDING",
    "statusLabel": "Pendente",
    "billingType": "PIX",
    "amount": 79.9,
    "netAmount": 76.91,
    "feeAmount": 2.99,
    "notificationFeeAmount": 0,
    "installmentCount": 1,
    "description": "Pedido 123",
    "dueAt": "2026-06-15T23:59:59.000Z",
    "dueDate": "2026-06-15",
    "paidAt": "2026-05-31T14:22:00.000Z",
    "estimatedCreditDate": "2026-06-02T00:00:00.000Z",
    "invoiceUrl": "https://...",
    "bankSlipUrl": null,
    "digitableLine": null,
    "pixCopyPaste": "00020101021226730014br.gov.bcb.pix...",
    "pixEncodedImage": "iVBORw0KGgo...",
    "accountTransactionId": "clx_ledger",
    "externalReference": "pedido-123",
    "createdAt": "2026-05-30T10:00:00.000Z",
    "customer": {
      "id": "clx_customer",
      "name": "Cliente Exemplo",
      "taxId": "12345678909"
    }
  },
  "requestId": "req_abc123"
}

​
Corpo da requisição

​
salesCustomerId
string
ID do cliente cadastrado (POST /customers/create).
​
customerName
string
Nome do pagador (se não usar salesCustomerId).
​
customerTaxId
string
CPF/CNPJ do pagador (se não usar salesCustomerId).
​
customerEmail
string
E-mail do pagador.
​
billingType
string
required
BOLETO, CREDIT_CARD, DEBIT_CARD ou VOUCHER.
​
amount
number
required
Valor em reais.
​
description
string
Descrição exibida ao pagador.
​
dueDate
string
YYYY-MM-DD (boleto; padrão +3 dias).
​
installmentCount
number
Parcelas 1–21 (cartão crédito).
​
creditCardToken
string
Token do cartão para cobranças seguintes.
​
creditCardHolderInfo
object
Titular: name, email, cpfCnpj, postalCode, addressNumber, phone.
​
externalReference
string
ID do seu sistema.
Pagamento único. Cartão: primeira vez com dados do titular; depois use creditCardToken. Para cobrança recorrente use POST /subscriptions/create.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
​
method
enum<string>
required
Available options:
BOLETO,
CARD_CREDIT,
CARD_DEBIT,
CARD_VOUCHER,
PIX
​
amount
number
required
Required range: x >= 0.01
​
customer
object
required
​
description
string
​
dueDate
string<date>
​
installmentCount
integer
Required range: 1 <= x <= 21
​
cardToken
string

Token do cartão para reutilização em cobranças futuras.

​
creditCard
object
​
creditCardHolderInfo
object
​
remoteIp
string

IP do comprador (obrigatório em CARD_*)

​
authorizeOnly
boolean
​
externalReference
string

Response

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Operação concluída com sucesso"

​
data
object
required
​
requestId
string