Primeiros Passos
Auth & Identidade
Gestão de Acesso
Pagar Fatura
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/invoices/{invoiceId}/pay \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentMethodId": "<string>"
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Invoices
Pagar Fatura
Processar pagamento de uma fatura aberta ou com falha usando um metodo de pagamento especifico.
POST
/
organizations
/
{organizationId}
/
invoices
/
{invoiceId}
/
pay
Pagar Fatura
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/invoices/{invoiceId}/pay \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentMethodId": "<string>"
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Paga uma fatura.
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/invoices/INVOICE_ID/pay \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"paymentMethodId": "pm_abc123"
}'
Apenas faturas com status
OPEN ou PAYMENT_FAILED podem ser pagas. Tentar pagar uma fatura ja paga ou anulada retornara 409 invoice.not_payable.Requer permissao
invoice:pay.Cabecalhos
Token bearer.
Parametros de Rota
O UUID da organizacao.
O UUID da fatura.
Corpo da Requisicao
ID do metodo de pagamento.
Resposta
O UUID da fatura.
O UUID da organizacao.
O ID da assinatura.
Referencia externa.
O tipo da fatura.
O tipo de metodo de pagamento utilizado.
Detalhes do cartao, se o metodo de pagamento for
CARD.Detalhes do boleto, se o metodo de pagamento for
BOLETO.O codigo da moeda.
Valor total em centavos.
Valor do desconto em centavos.
Valor a pagar em centavos.
Descontos aplicados.
Itens da fatura.
Configuracao do limiar de cobranca.
O status da fatura.
Timestamp de emissao ISO 8601.
Data de vencimento ISO 8601.
Timestamp de pagamento ISO 8601.
Timestamp de criacao ISO 8601.
Timestamp da ultima atualizacao ISO 8601.
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
404 | organization.not_found | Organizacao nao encontrada |
404 | invoice.not_found | Fatura nao encontrada |
409 | invoice.not_payable | Fatura nao esta em estado pagavel |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.