Skip to main content
PATCH
/
organizations
/
{organizationId}
/
payment-methods
/
{paymentMethodId}
Atualizar Metodo de Pagamento
curl --request PATCH \
  --url https://api.example.com/organizations/{organizationId}/payment-methods/{paymentMethodId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingDetails": {
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "address": {}
  }
}
'
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}
Atualiza um metodo de pagamento pelo ID.
curl -X PATCH https://api.awsales.io/studio/organizations/ORG_ID/payment-methods/PM_ID \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "billingDetails": {
      "name": "John Doe Updated",
      "email": "john.new@example.com"
    }
  }'
Requer permissao payment_method:write.

Cabecalhos

Authorization
string
required
Token bearer.

Parametros de Rota

organizationId
string
required
O UUID da organizacao.
paymentMethodId
string
required
O ID do metodo de pagamento.

Corpo da Requisicao

billingDetails
object
Dados de cobranca atualizados (parcial).

Resposta

paymentMethodId
string
O ID do metodo de pagamento.
organizationId
string
O UUID da organizacao.
type
string
O tipo do metodo de pagamento (CARD ou BOLETO).
brand
string
Bandeira do cartao. Presente apenas para tipo CARD.
last4
string
Ultimos quatro digitos. Presente apenas para tipo CARD.
expMonth
integer
Mes de expiracao. Presente apenas para tipo CARD.
expYear
integer
Ano de expiracao. Presente apenas para tipo CARD.
isDefault
boolean
Se este e o metodo de pagamento padrao.
billingDetails
object
Informacoes de contato de cobranca.
{
  "statusCode": 400,
  "message": "Bad Request Error",
  "errors": [{"message": "required", "path": "field"}]
}

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