Skip to main content
Um metodo de pagamento representa um instrumento de pagamento armazenado vinculado a uma organizacao. O AWSales suporta dois tipos: cartoes de credito/debito (CARD) e boletos bancarios (BOLETO). Cada organizacao pode ter ate 3 metodos de pagamento por cartao e 1 metodo de pagamento por boleto, com um designado como padrao. Voce encontrara objetos de metodo de pagamento ao gerenciar configuracoes de cobranca ou processar pagamentos de faturas. O objeto metodo de pagamento e uma union discriminada baseada no campo type. A estrutura varia dependendo se o tipo e CARD ou BOLETO.

​
Cartao

​
paymentMethodId
string
O identificador unico do metodo de pagamento.
​
organizationId
string
O ID da organizacao.
​
type
string
O tipo de metodo de pagamento. Literal CARD.
​
brand
string
A bandeira do cartao (ex.: visa, mastercard).
​
last4
string
Os ultimos quatro digitos do numero do cartao.
​
expMonth
integer
O mes de expiracao do cartao.
​
expYear
integer
O ano de expiracao do cartao.
​
isDefault
boolean
Se este e o metodo de pagamento padrao.
​
billingDetails
object
Os dados de cobranca associados a este metodo de pagamento.
{
  "paymentMethodId": "pm_1Oy2pL2eZvKYlo2C0vIqMZ8y",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "type": "CARD",
  "brand": "visa",
  "last4": "4242",
  "expMonth": 12,
  "expYear": 2027,
  "isDefault": true,
  "billingDetails": {
    "name": "Maria Silva",
    "email": "maria@example.com",
    "phone": "+5511999990000",
    "address": {
      "line1": "Av. Paulista, 1000",
      "city": "Sao Paulo",
      "state": "SP",
      "postalCode": "01310-100",
      "country": "BR"
    }
  }
}

​
Boleto

​
paymentMethodId
string
O identificador unico do metodo de pagamento.
​
organizationId
string
O ID da organizacao.
​
type
string
O tipo de metodo de pagamento. Literal BOLETO.
​
isDefault
boolean
Se este e o metodo de pagamento padrao.
​
billingDetails
object
Os dados de cobranca associados a este metodo de pagamento.
{
  "paymentMethodId": "pm_2Bz3qM3fAwLZmp3D1wJrNA9z",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "type": "BOLETO",
  "isDefault": false,
  "billingDetails": {
    "name": "Maria Silva",
    "email": "maria@example.com",
    "phone": "+5511999990000",
    "address": {
      "line1": "Av. Paulista, 1000",
      "city": "Sao Paulo",
      "state": "SP",
      "postalCode": "01310-100",
      "country": "BR"
    }
  }
}