Skip to main content
POST
/
invoices
/
{invoiceId}
/
pay
Pagar Fatura
curl --request POST \
  --url https://api.example.com/invoices/{invoiceId}/pay \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentMethodId": "<string>"
}
'
{
  "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "externalRef": "inv_stripe_abc123",
  "type": "PLAN",
  "paymentMethod": "CARD",
  "card": { "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2027 },
  "boleto": null,
  "currency": "BRL",
  "totalAmount": 4900,
  "discountAmount": 0,
  "payableAmount": 4900,
  "discounts": [],
  "lines": [
    { "id": "01HX...", "name": "Starter Plan - Monthly", "unitPrice": 4900, "quantity": 1, "amount": 4900 }
  ],
  "billingThreshold": null,
  "status": "PAID",
  "issuedAt": "2026-03-01T00:00:00.000Z",
  "dueDate": "2026-03-15T00:00:00.000Z",
  "paidAt": "2026-03-25T14:00:00.000Z",
  "createdAt": "2026-03-01T00:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}
Requer permissao invoice:pay.

Headers

Authorization
string
required
Bearer token.

Parametros de Path

invoiceId
string
required
UUID da fatura.

Corpo da Requisicao

paymentMethodId
string
ID do metodo de pagamento.

Resposta

invoiceId
string
UUID da fatura.
organizationId
string
UUID da organizacao.
subscriptionId
string
ID da assinatura.
externalRef
string
Referencia externa.
type
string
Tipo da fatura.
paymentMethod
string
Metodo de pagamento.
card
object
Detalhes do cartao (quando o metodo de pagamento e CARD).
boleto
object
Detalhes do boleto (quando o metodo de pagamento e BOLETO).
currency
string
Codigo da moeda.
totalAmount
integer
Valor total em centavos.
discountAmount
integer
Valor de desconto em centavos.
payableAmount
integer
Valor a pagar em centavos.
discounts
array
Descontos aplicados.
lines
array
Itens da fatura.
billingThreshold
object
Limite de faturamento (nullable).
status
string
Status da fatura.
issuedAt
string
Timestamp de emissao.
dueDate
string
Data de vencimento.
paidAt
string
Timestamp de pagamento.
createdAt
string
Timestamp de criacao.
updatedAt
string
Timestamp da ultima atualizacao.
{
  "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "externalRef": "inv_stripe_abc123",
  "type": "PLAN",
  "paymentMethod": "CARD",
  "card": { "brand": "visa", "last4": "4242", "expMonth": 12, "expYear": 2027 },
  "boleto": null,
  "currency": "BRL",
  "totalAmount": 4900,
  "discountAmount": 0,
  "payableAmount": 4900,
  "discounts": [],
  "lines": [
    { "id": "01HX...", "name": "Starter Plan - Monthly", "unitPrice": 4900, "quantity": 1, "amount": 4900 }
  ],
  "billingThreshold": null,
  "status": "PAID",
  "issuedAt": "2026-03-01T00:00:00.000Z",
  "dueDate": "2026-03-15T00:00:00.000Z",
  "paidAt": "2026-03-25T14:00:00.000Z",
  "createdAt": "2026-03-01T00:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}

Exemplos de Codigo

curl -X POST https://api.awsales.io/admin/invoices/019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e/pay \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentMethodId": "pm_1Oy2pL2eZvKYlo2C0vIqMZ8y"
}'

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404invoice.not_foundFatura nao encontrada
409invoice.not_payableInvoice is not in a payable state
500internal_server_errorOcorreu um erro inesperado