Pular para o conteúdo principal

Criar sessão de checkout

POST/api/v1/bank/wallet/checkout/Bearer Token

Cabeçalhos da requisição

CabeçalhoValorObrigatório
AuthorizationBearer {A55_ACCESS_TOKEN}Sim
Content-Typeapplication/jsonSim
Idempotency-KeyUUID v4Recomendado

Corpo da requisição

CampoTipoObrigatórioDescrição
wallet_uuidstring (UUID)SimCarteira que recebe os fundos
merchant_idstring (UUID)SimIdentificador do estabelecimento
amountnumberSimValor total da cobrança (ex.: 250.00)
currencystringSimCódigo de moeda ISO 4217
descriptionstringSimDescrição da cobrança exibida na página de checkout
redirect_urlstringSimURL de redirecionamento após a conclusão do pagamento
cancel_urlstringNãoURL de redirecionamento se o pagador cancelar
due_datestringSimData de expiração YYYY-MM-DD
payer_emailstringNãoPreencher previamente o e-mail do pagador na página de checkout
allowed_methodsarrayNãoRestringir métodos de pagamento (ex.: ["credit_card", "pix"])
max_installmentsintegerNãoMáximo de parcelas permitidas (padrão: configuração da carteira)
webhook_urlstringNãoSubstituir a URL de webhook padrão
reference_external_idstringNãoSeu ID de pedido interno
is_checkoutbooleanNãotrue (padrão para este endpoint)

Campos da resposta

CampoTipoDescrição
checkout_uuidstringIdentificador único da sessão de checkout
checkout_urlstringURL da página de checkout hospedada — redirecione o pagador para cá
statusstringactive — sessão pronta para pagamento
amountnumberValor do checkout
currencystringCódigo da moeda
expires_atstringExpiração da sessão ISO 8601
charge_uuidstringCriado quando o pagador conclui o pagamento

Códigos de status HTTP

StatusDescrição
200Sessão de checkout criada
400Corpo da requisição inválido ou campos obrigatórios ausentes
401Token Bearer inválido ou expirado
403Permissões insuficientes para esta carteira
404Carteira ou estabelecimento não encontrado
422Erro de validação (moeda inválida, valor inválido)
429Limite de requisições excedido
500Erro interno do servidor — tente novamente com backoff exponencial

Exemplos de código

curl -s -X POST https://core-manager.a55.tech/api/v1/bank/wallet/checkout/ \
-H "Authorization: Bearer $A55_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 990e8400-e29b-41d4-a716-446655440004" \
-d '{
"wallet_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"merchant_id": "11111111-1111-1111-1111-111111111111",
"amount": 250.00,
"currency": "BRL",
"description": "Premium Plan — Monthly",
"redirect_url": "https://your-app.com/payment/success",
"cancel_url": "https://your-app.com/payment/cancel",
"due_date": "2026-12-31",
"payer_email": "maria@example.com",
"allowed_methods": ["credit_card", "pix"],
"max_installments": 6,
"webhook_url": "https://your-app.com/webhooks/a55",
"reference_external_id": "ORDER-2048"
}'

Exemplo de resposta de erro

{
"status": "error",
"message": [
{
"code": "INVALID_REDIRECT_URL",
"source": "validation",
"description": "redirect_url must be a valid HTTPS URL"
}
]
}