API — Pagamentos

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.

---

GET /api/payments/connect/status

Get Connect Status

Exemplo resposta (200):

{
  "account_id": null,
  "status": "string",
  "charges_enabled": true,
  "payouts_enabled": true,
  "requirements_due": [
    "..."
  ]
}

---

POST /api/payments/connect/onboard

Start Onboarding

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
business_name	string	Sim	Business Name
first_name	string	Sim	First Name
last_name	string	Sim	Last Name
email	string	Sim	Email
phone	object	Nao	Phone
dob	string	Sim	Dob
address	string	Sim	Address
city	string	Sim	City
postal_code	string	Sim	Postal Code
nif	string	Sim	Nif
iban	string	Sim	Iban
tos_accepted	boolean	Nao	Tos Accepted

Exemplo pedido:

{
  "business_name": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": null,
  "dob": "string",
  "address": "string",
  "city": "string",
  "postal_code": "string",
  "nif": "string",
  "iban": "string",
  "tos_accepted": true
}

Exemplo resposta (200):

{
  "account_id": null,
  "status": "string",
  "charges_enabled": true,
  "payouts_enabled": true,
  "requirements_due": [
    "..."
  ]
}

Erros possiveis: 422 Validation Error

---

GET /api/payments/connect/dashboard

Get Dashboard Link

Exemplo resposta (200):

{}

---

POST /api/payments/connect/payout

Request Payout

Parametros:

Nome	Tipo	Obrigatorio	Descricao
amount	integer	Sim	—

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error

---

POST /api/payments/create-intent

Create Payment Intent

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
order_id	integer	Sim	Order Id

Exemplo pedido:

{
  "order_id": 0
}

Exemplo resposta (200):

{
  "payment_intent_id": "string",
  "client_secret": "string",
  "amount_cents": 0,
  "currency": "string",
  "platform_fee_cents": 0
}

Erros possiveis: 422 Validation Error

---

POST /api/payments/refund

Create Refund

Corpo do pedido:

Campo	Tipo	Obrigatorio	Descricao
order_id	integer	Sim	Order Id
amount_cents	object	Nao	Amount Cents
reason	object	Nao	Reason

Exemplo pedido:

{
  "order_id": 0,
  "amount_cents": null,
  "reason": null
}

Exemplo resposta (200):

{}

Erros possiveis: 422 Validation Error

---

Documentacao gerada automaticamente.