Cleo

Bank transfer payment provider supporting multiple Latin American markets (Chile, Peru, Mexico). Pay-In and Pay-Out.

Operations: Pay-In ✓ | Pay-Out ✓ | Webhook ✓
Processing: Asynchronous - redirect user to hosted page; final status via webhook
Markets: Chile (CLP), Peru (PEN), Mexico (MXN)

Currency restriction: Cleo only processes local currencies. Use "CLP" for Chile, "PEN" for Peru, and "MXN" for Mexico. No other currencies are accepted.

Fields marked with * are required.

Configuration (Mozarto back office)

Field	Description
`cleoApiKey.chileApiKey` *	API key for Chile transactions
`cleoApiKey.peruApiKey` *	API key for Peru transactions
`cleoApiKey.mexicoApiKey` *	API key for Mexico transactions
`customerExternalKeyForCleo` *	Your external key identifier for Cleo
`webhookUrl` *	Your HTTPS endpoint for transaction status updates
`isWebhookSecured`	Adds `Authorization` header to outbound webhook calls

The correct regional API key is selected automatically based on the countryCode in the transaction request.

Pay-In

POST /v1/api/mozarto/cashier

Request body

Field	Type	Description
`pspType` *	string	Always `"CLEO"`
`type` *	string	Always `"PAYIN"`
`baseamount` *	number	Amount as a number (e.g. `10000.00`)
`currency` *	string	Currency code (e.g. `"CLP"`, `"PEN"`, `"MXN"`)
`currencyCode` *	string	Currency code
`userId` *	string	Your internal user/player identifier
`email` *	string	User's email address
`firstName` *	string	User's first name
`lastName` *	string	User's last name
`phone` *	string	Phone number (min 6 digits)
`gender` *	string	User's gender
`dob` *	string	Date of birth (e.g. `"1990-01-15"`)
`countryCode` *	string	Country code - determines which regional API key is used (`"CL"`, `"PE"`, `"MX"`)
`kycVerified` *	boolean	KYC verification status
`blocked` *	boolean	Whether user is blocked
`isVelocity` *	boolean	Velocity check flag
`transactionCount` *	string	Number of prior transactions
`userBalance` *	number	User's current balance
`partnerName` *	string	Partner/operator name
`emailVerification` *	string	Verified email address
`verificationDate` *	string	Date email was verified
`brandId`	string	Brand identifier
`bonusCode`	string	Bonus code
`address` *	object	`{ line1, line2?, city, state, postalCode, country }`

Example request

{
  "pspType": "CLEO",
  "type": "PAYIN",
  "baseamount": 10000.00,
  "currency": "CLP",
  "currencyCode": "CLP",
  "userId": "user_123",
  "email": "player@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "56912345678",
  "gender": "male",
  "dob": "1988-05-20",
  "countryCode": "CL",
  "kycVerified": true,
  "blocked": false,
  "isVelocity": false,
  "transactionCount": "1",
  "userBalance": 0,
  "partnerName": "ExamplePartner",
  "emailVerification": "player@example.com",
  "verificationDate": "2024-01-01",
  "address": {
    "line1": "Av. Libertador 1234",
    "city": "Santiago",
    "state": "RM",
    "postalCode": "8320000",
    "country": "CL"
  }
}

Response

{
  "status": "success",
  "isSuccess": true,
  "data": {
    "status": "PENDING",
    "url": "https://checkout.cleo.finance/...",
    "sessionId": "60a74038-5b94-427e-8cff-abc123"
  }
}

Pay-Out

POST /v1/api/mozarto/cashier

Uses the same request body as Pay-In, with type set to "PAYOUT".

Response

{
  "status": "success",
  "isSuccess": true,
  "data": {
    "status": "PENDING",
    "sessionId": "60a74038-5b94-427e-8cff-abc123"
  }
}

Webhook

Mozarto calls your webhookUrl when the transaction reaches a final state.

The method field will be CLEO_PAYIN or CLEO_PAYOUT.

Error codes

Cleo Pay-In transport failures are mapped to normalized Mozarto errorCode values. Use errorCode for programmatic handling rather than parsing the raw Cleo response.

Mozarto `errorCode`	PSP raw signal	When
`INVALID_PSP_CREDENTIALS`	HTTP 404 / 401 / 403	Cleo API key (per-country) is missing, wrong, or the account is not active
`PSP_TIMEOUT`	HTTP 408 or response body contains `"timeout"`	Cleo did not respond in time - safe to retry
`PSP_UNAVAILABLE`	HTTP 5xx	Cleo service error - safe to retry with backoff
`PSP_RATE_LIMITED`	HTTP 429	Too many requests - retry after a delay
`UNKNOWN_PSP_ERROR`	Any other response	Unrecognised error - check the raw response and contact support if it persists

For the full list of errorCode values and retryability guidance, see Errors.

Configuration (Mozarto back office)#

Pay-In#

Request body#

Example request#

Response#

Pay-Out#

Response#

Webhook#

Error codes#

Configuration (Mozarto back office)

Pay-In

Request body

Example request

Response

Pay-Out

Response

Webhook

Error codes