Skip to main content
GET
/
v1
/
payouts
/
orders
/
{id}
Consultar ordem de pagamento pelo ID
curl --request GET \
  --url https://api.malga.io/v1/payouts/orders/{id} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
{
  "id": "0f3d5b1a-7c89-4f23-9bd6-aabbccddeeff",
  "chargeId": "1c1e6a87-44ab-44d9-9311-9876543210ab",
  "amount": 9700,
  "grossAmount": 10000,
  "totalFeeAmount": 300,
  "currency": "BRL",
  "installment": 1,
  "totalInstallments": 1,
  "paymentMethod": "credit",
  "type": "capture",
  "paymentArrangement": "VCC",
  "paymentScheduledAt": "2026-04-28",
  "paymentBatchId": "9b1a3a3e-2f87-4b2f-ae59-1234567890ab",
  "createdAt": "2026-04-20T15:30:00.000Z",
  "updatedAt": "2026-04-20T15:30:00.000Z"
}

Authorizations

​
X-Client-Id
string
header
required
​
X-Api-Key
string
header
required

Path Parameters

​
id
string<uuid>
required

Identificador da ordem de pagamento

Query Parameters

​
sellerId
string<uuid>

Filtra a ordem de pagamento por seller

Response

Detalhes da ordem de pagamento

​
id
string<uuid>

Identificador único da ordem

​
chargeId
string<uuid>

Identificador da cobrança na Malga que originou a ordem

​
amount
integer

Valor líquido conciliado da ordem em centavos

​
grossAmount
integer

Valor bruto da ordem em centavos

​
totalFeeAmount
integer

Total de taxas aplicadas à ordem, em centavos

​
currency
string

Moeda da ordem no formato ISO 4217

Example:

"BRL"

​
installment
integer | null

Número da parcela representada pela ordem

​
totalInstallments
integer | null

Total de parcelas da cobrança original

​
paymentMethod
enum<string>

Meio de pagamento da ordem

Available options:
credit,
pix,
nupay
​
type
enum<string>

Tipo da operação financeira que a ordem representa:

  • authorization: autorização da transação
  • void: cancelamento antes da liquidação
  • charge_back: estorno pós-liquidação
Available options:
authorization,
void,
charge_back
​
paymentArrangement
string | null

Arranjo de pagamento associado à ordem

​
paymentScheduledAt
string<date> | null

Data programada para liquidação da ordem no formato YYYY-MM-DD

​
paymentBatchId
string<uuid> | null

Identificador do repasse que liquidou esta ordem

​
createdAt
string<date-time>

Data de criação da ordem em RFC 3339

​
updatedAt
string<date-time>

Data da última atualização da ordem em RFC 3339