Skip to main content
GET
Consultar ordem de pagamento pelo ID

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