Listar Metodos de Pagamento

curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/payment-methods \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "paymentMethodId": "pm_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "type": "CARD",
      "brand": "visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2027,
      "isDefault": true,
      "billingDetails": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+5511999999999",
        "address": {
          "line1": "Av Paulista 1000",
          "line2": null,
          "city": "Sao Paulo",
          "state": "SP",
          "postalCode": "01310-100",
          "country": "BR"
        }
      }
    }
  ]
}

GET

organizations

{organizationId}

payment-methods

Listar Metodos de Pagamento

curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/payment-methods \
  --header 'Authorization: <authorization>'

{
  "data": [
    {
      "paymentMethodId": "pm_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "type": "CARD",
      "brand": "visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2027,
      "isDefault": true,
      "billingDetails": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+5511999999999",
        "address": {
          "line1": "Av Paulista 1000",
          "line2": null,
          "city": "Sao Paulo",
          "state": "SP",
          "postalCode": "01310-100",
          "country": "BR"
        }
      }
    }
  ]
}

Requer permissao payment_method:read.

Headers

Authorization

string

required

Bearer token.

Parametros de Path

organizationId

string

required

UUID da organizacao.

Resposta

data

array

Lista de metodos de pagamento.

Show propriedades do metodo de pagamento

paymentMethodId

string

ID do metodo de pagamento.

organizationId

string

UUID da organizacao.

type

string

Payment method type (CARD or BOLETO).

brand

string

Card brand (CARD only).

last4

string

Last 4 digits (CARD only).

expMonth

integer

Expiration month (CARD only).

expYear

integer

Expiration year (CARD only).

isDefault

boolean

Whether it is the default payment method.

billingDetails

object

Billing details.

Show billingDetails properties

name

string

Billing name.

string

Email de billing.

phone

string

Billing phone.

address

object

Endereco de billing.

{
  "data": [
    {
      "paymentMethodId": "pm_abc123",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "type": "CARD",
      "brand": "visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2027,
      "isDefault": true,
      "billingDetails": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+5511999999999",
        "address": {
          "line1": "Av Paulista 1000",
          "line2": null,
          "city": "Sao Paulo",
          "state": "SP",
          "postalCode": "01310-100",
          "country": "BR"
        }
      }
    }
  ]
}

Exemplos de Codigo

curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/payment-methods \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Codigos de Erro

Status	Codigo	Descricao
`400`	`validation_error`	Entrada invalida ou campos obrigatorios ausentes
`401`	`unauthorized`	Autenticacao ausente ou invalida
`403`	`forbidden`	Permissoes insuficientes
`404`	`organization.not_found`	Organizacao nao encontrada
`500`	`internal_server_error`	Ocorreu um erro inesperado

O Objeto Metodo de Pagamento

Buscar Metodo de Pagamento

⌘I

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

Listar Metodos de Pagamento

Headers

Parametros de Path

Resposta

Exemplos de Codigo

Codigos de Erro

Primeiros Passos

Auth & Identidade

Gestão de Acesso

Faturamento

​Headers

​Parametros de Path

​Resposta

​Exemplos de Codigo

​Codigos de Erro

Headers

Parametros de Path

Resposta

Exemplos de Codigo

Codigos de Erro