Skip to main content

Create checkout session

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

Request headers

HeaderValueRequired
AuthorizationBearer {A55_ACCESS_TOKEN}Yes
Content-Typeapplication/jsonYes
Idempotency-KeyUUID v4Recommended

Request body

FieldTypeRequiredDescription
wallet_uuidstring (UUID)YesWallet that receives the funds
merchant_idstring (UUID)YesMerchant identifier
amountnumberYesTotal charge amount (e.g., 250.00)
currencystringYesISO 4217 currency code
descriptionstringYesCharge description shown on checkout page
redirect_urlstringYesURL to redirect after payment completes
cancel_urlstringNoURL to redirect if payer cancels
due_datestringYesExpiration date YYYY-MM-DD
payer_emailstringNoPre-fill payer email on checkout page
allowed_methodsarrayNoRestrict payment methods (e.g., ["credit_card", "pix"])
max_installmentsintegerNoMax installments allowed (default: wallet config)
webhook_urlstringNoOverride default webhook URL
reference_external_idstringNoYour internal order ID
is_checkoutbooleanNotrue (default for this endpoint)

Response fields

FieldTypeDescription
checkout_uuidstringUnique checkout session identifier
checkout_urlstringHosted checkout page URL — redirect the payer here
statusstringactive — session is ready for payment
amountnumberCheckout amount
currencystringCurrency code
expires_atstringISO 8601 session expiration
charge_uuidstringCreated when payer completes payment

HTTP status codes

StatusDescription
200Checkout session created
400Invalid request body or missing required fields
401Invalid or expired Bearer token
403Insufficient permissions for this wallet
404Wallet or merchant not found
422Validation error (invalid currency, amount)
429Rate limit exceeded
500Internal server error — retry with exponential backoff

Code examples

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"
}'

Error response example

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