Criar pagamento

POST https://.account-name.krzlabs.io/api/v1/orders/:id/payments

Cria um novo pagamento no pedido.

---

Path Params

id string required

Identificador único do pedido.

---

Body Params

Field	Type	Description	Optional	Searchable
_id	string	Identificador único do pagamento	required	false
order_code	string	Código do pedido relacionado	required	false
external_code	string	Código externo associado ao pagamento	required	false
installments	number	Número de parcelas do pagamento	required	false
balance	number	Saldo pendente do pagamento	required	false
total	number	Valor total do pagamento	required	false
paid_at	Date	Data e hora em que o pagamento foi efetuado	required	false
due_date	Date	Data de vencimento do pagamento	required	false
data	object	Dados adicionais relacionados ao pagamento	required	false
status	OrderPaymentStatusEnum	Status atual do pagamento	required	false
method +	PaymentMethodType	Método de pagamento utilizado	required	false
metadata	Record(string, string)	Metadados adicionais do pagamento	required	false
transactions +	Array(PaymentTransactionType)	Lista de transações associadas ao pagamento	not required	false

Field	Value
PENDING	'PENDING'
CANCELED	'CANCELED'
PAID	'PAID'
FAILED	'FAILED'
REFUNDED	'REFUNDED'

Exemplo em JSON

{
  "_id": "66b8f3d8d9f4ab1234567890",
  "order_code": "ORD-20250813-001",
  "external_code": "EXT-987654",
  "installments": 3,
  "balance": 250.75,
  "total": 750.00,
  "paid_at": "2025-08-10T14:30:00Z",
  "due_date": "2025-08-15T23:59:59Z",
  "data": {
    "currency": "BRL",
    "payment_gateway": "Stripe"
  },
  "status": "PAID",
  "method": {
    "_id": "pm-001",
    "code": "CREDIT_CARD",
    "name": "Cartão de Crédito"
  },
  "metadata": {
    "customer_id": "cust-12345",
    "invoice_number": "INV-20250810-001"
  },
  "transactions": [
    {
      "_id": "txn-001",
      "order_code": "ORD-20250813-001",
      "order_payment_id": "66b8f3d8d9f4ab1234567890",
      "external_id": "ext-txn-98765",
      "provider": "Stripe",
      "data": {
        "auth_code": "123456",
        "status_detail": "Pagamento aprovado"
      }
    },
    {
      "_id": "txn-002",
      "order_code": "ORD-20250813-001",
      "order_payment_id": "66b8f3d8d9f4ab1234567890",
      "external_id": "ext-txn-98766",
      "provider": "Stripe",
      "data": {
        "auth_code": "654321",
        "status_detail": "Parcela processada"
      }
    }
  ]
}

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

Field	Type	Description	Optional	Searchable
_id	string	Identificador único do pagamento	required	false
order_code	string	Código do pedido relacionado	required	false
external_code	string	Código externo associado ao pagamento	required	false
installments	number	Número de parcelas do pagamento	required	false
balance	number	Saldo pendente do pagamento	required	false
total	number	Valor total do pagamento	required	false
paid_at	Date	Data e hora em que o pagamento foi efetuado	required	false
due_date	Date	Data de vencimento do pagamento	required	false
data	object	Dados adicionais relacionados ao pagamento	required	false
status	OrderPaymentStatusEnum	Status atual do pagamento	required	false
method +	PaymentMethodType	Método de pagamento utilizado	required	false
metadata	Record(string, string)	Metadados adicionais do pagamento	required	false
transactions +	Array(PaymentTransactionType)	Lista de transações associadas ao pagamento	not required	false

Resposta de erro

400

Bad Request

Field	Type	Description
code	Number	Código da resposta http
kind	String	Tipo de mensagem
name	String	Nome da exceção lançada pela plataforma
title	String	Titulo do erro lançado pela plataforma
message	String	Mensagem indicando o probloma ocorrido
solution	String	Mensagem indicando uma possível solução para o problema