Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upag.io/llms.txt

Use this file to discover all available pages before exploring further.

Os métodos de pagamento permitem que seus clientes realizem transações através de cartão de crédito ou PIX.

​
Estrutura

Um método de pagamento é representado em nossa API pela seguinte estrutura: 
{
  "id": "pm_abc123xyz",
  "livemode": false,
  "type": "credit_card",
  "expiresIn": null,
  "expiryMonth": "12",
  "expiryYear": "2025",
  "firstDigits": "4111",
  "lastDigits": "1111",
  "brand": "visa",
  "holderName": "JOHN DOE",
  "createdAt": 1731622178441,
  "updatedAt": 1731622178441
}

​
Atributos

{
  "id": "pm_abc123xyz",
}
id : string.
Identificador único do método de pagamento, começando com pm_
{
  "livemode": false,
}
livemode : boolean.
Indica se o método de pagamento está em modo de produção (true) ou teste (false)
{
  "type": "credit_card",
}
type : string.
Tipo do método de pagamento
TipoDescrição
credit_cardCartão de crédito
pixPIX
{
  "expiresIn": 600,
}
expiresIn : number | null.
Tempo de expiração em segundos (apenas para PIX). Pode ser null para cartões
{
  "expiryMonth": "12",
}
expiryMonth : string | null.
Mês de expiração do cartão (MM). Pode ser null para PIX
{
  "expiryYear": "2025",
}
expiryYear : string | null.
Ano de expiração do cartão (YYYY). Pode ser null para PIX
{
  "firstDigits": "4111",
}
firstDigits : string | null.
Primeiros dígitos do cartão. Pode ser null para PIX
{
  "lastDigits": "1111",
}
lastDigits : string | null.
Últimos 4 dígitos do cartão. Pode ser null para PIX
{
  "brand": "visa",
}
brand : string | null.
Bandeira do cartão (ex.: visa, mastercard). Pode ser null para PIX
{
  "holderName": "JOHN DOE",
}
holderName : string | null.
Nome do portador do cartão. Pode ser null para PIX
{
  "createdAt": 1731622178441,
}
createdAt : number.
Timestamp Unix indicando quando o método de pagamento foi criado
{
  "updatedAt": 1731622178441,
}
updatedAt : number.
Timestamp Unix indicando quando o método de pagamento foi atualizado pela última vez