Skip to main content
GET
/
organizations
/
{organizationId}
/
payment-methods
/
{paymentMethodId}
Buscar Metodo de Pagamento
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/payment-methods/{paymentMethodId} \
  --header 'Authorization: <authorization>'
{
  "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.
​
paymentMethodId
string
required
ID do metodo de pagamento.

​
Resposta

​
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.
{
  "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/pm_1Oy2pL2eZvKYlo2C0vIqMZ8y \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
404payment_method.not_foundMetodo de pagamento nao encontrado
500internal_server_errorOcorreu um erro inesperado