Primeiros Passos
Auth & Identidade
Gestão de Acesso
Criar Metodo de Pagamento
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/payment-methods \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"cardToken": "<string>",
"isDefault": true,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {}
}
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Payment Methods
Criar Metodo de Pagamento
Registrar um novo metodo de pagamento por cartao ou boleto para a organizacao.
POST
/
organizations
/
{organizationId}
/
payment-methods
Criar Metodo de Pagamento
curl --request POST \
--url https://api.example.com/organizations/{organizationId}/payment-methods \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "<string>",
"cardToken": "<string>",
"isDefault": true,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {}
}
}
'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Cria um novo metodo de pagamento.
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/payment-methods \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "CARD",
"cardToken": "tok_visa_4242",
"isDefault": false,
"billingDetails": {
"name": "John Doe",
"email": "john@example.com"
}
}'
Organizacoes podem ter no maximo 3 metodos de pagamento por cartao e 1 metodo de pagamento por boleto. Exceder esse limite retorna um erro de conflito
409.Requer permissao
payment_method:write.Cabecalhos
Token bearer.
Parametros de Rota
O UUID da organizacao.
Corpo da Requisicao
Tipo de metodo de pagamento. Um de:
CARD, BOLETO.Token do metodo de pagamento. Obrigatorio para tipo
CARD.Se deve definir como metodo de pagamento padrao.
Resposta
O ID do metodo de pagamento.
O UUID da organizacao.
O tipo do metodo de pagamento (
CARD ou BOLETO).Bandeira do cartao. Presente apenas para tipo
CARD.Ultimos quatro digitos. Presente apenas para tipo
CARD.Mes de expiracao. Presente apenas para tipo
CARD.Ano de expiracao. Presente apenas para tipo
CARD.Se este e o metodo de pagamento padrao.
Informacoes de contato de cobranca.
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
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 |
409 | payment_method.max_of_3_card_payment_methods_reached | Maximo de 3 metodos de pagamento por cartao atingido |
409 | payment_method.max_of_1_boleto_payment_methods_reached | Maximo de 1 metodo de pagamento por boleto atingido |
409 | payment_method.token_already_used | O token do metodo de pagamento ja foi utilizado |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.