Skip to content

Payout Account Type

accountTypeDescriptionExampleremarks
1CPF22*****9911 digits (excluding . and -)
2CNPJ23*******3114 digits
3EMAILmerchant@example.comUser email
4PHONE+5511987654321Must start with +55
5EVPTemporarily deactivate this payment method
UUID-like format xxxxx-xxxx-xxxx-xxx
32-digit alphanumeric string sent from the central bank to the institution
6RANDOMRandom payment

TIP

  • We will perform format verification and validity verification on CPF and CNPJ, and the channel will perform authenticity verification on CPF and CNPJ.
  • Format verification and validity verification will return the verification results synchronously. Orders that fail the verification will be directly rejected.
  • The authenticity verification will be verified by the Central Bank of Brazil after the order is submitted to the Central Bank of Brazil. Failure to pass the verification will result in withdrawal failure.
  • CPF verification algorithmRefer
  • CNPJ verification algorithmRefer

Payout Bank List

TIP

The bank support list is subject to the actual support status of the production environment. It is recommended that you call our bank list query interface to confirm the production bank support status before entering the production environment.

Brazil is all PIX and there is no bank list

Payout Order Status Enum

ParameterDescriptionRemark
PROCESSINGPROCESSING
WAITINGWait for payment
PAYINGPayment Paying
SUCCESSPayment successfulOrder final status
FAILPayment failedOrder final status
CANCELOrder CanceledOrder final status

TIP

Note that when processing callbacks or query results from Cashy, the order status should be accurately judged. Only the final result can be considered as a clear success of the collection order.

Payout Order Status Description

ValueDescription
ACCOUNT_NOT_EXISTAccount does not exist
ACCOUNT_FREEZINGAccount Freeze
ACCOUNT_CANCELAccount canceled
ACCOUNT_IN_ANOTHER_CURRENCYAccount in another currency
ACCOUNT_NOT_BELONG_TOAccount does not belong to receiving participant
ACCOUNT_EXCEPTIONAccount Status Exception
MCH_NOT_KNOW_PAYMENTThe payee does not acknowledge the payment
MISS_MUST_PAYMENT_INFOMissing required information to complete payment
ERROR_PAYMENT_TYPEWrong payment method
ERROR_OPERATION_TYPEWrong operation type
ACCOUNT_TYPE_NOT_APPLICABLEAccount type not applicable
INVALID_CHARACTERInvalid character
OUT_ACCOUNT_BALANCEExceeded authorized account balance limit
OUT_ACCOUNT_MONTH_BALANCEExceeded the credit limit allowed for the account for the month
NOT_REGISTER_TELPHONEUnregistered mobile number
NOT_RECEIVE_BANXICO_PAYMENTAdditional accounts will not receive payments not from Banxico
INFO_STRUCTURE_INVALIDThe additional information structure is incorrect
UNKNOWN_ERRORUnknown exception
SUCCESSSuccess
AMOUNT_ERRORWrong amount
PARAM_ERRORParameter error
NOT_SUPPORTED_CASHCash payment is not supported
NOT_SUPPORTED_CREDITCredit card payment is not supported
SYSTEM_ERRORSystem exception
RUT_INVALIDInvalid RUT
COMPLIANCE_REJECTPayment declined for compliance reasons
INVALID_CCIInvalid CCI
INVALID_BANK_ACCOUNTInvalid bank account

Payin Payer ID Type

idTypeDescription
CPFCPF

Payin PayType Enum

ValueDescription
140PIX

Payin Order Status Enum

ParameterDescriptionRemark
PAYINGWait for payment
SUCCESSPayment successfulOrder final status
FAILPayment failedOrder final status

TIP

Note that when processing callbacks or query results from Cashy, the order status should be accurately judged. Only the final result can be considered as a clear success of the collection order.

Common Error Messages

ValueDescriptionCountries covered
System_errorSystem errorAll
System_busySystem busy (Can retry)All
System_MaintenanceSystem Maintenance (Can retry)All
MerchantId_is_nullMerchantId is emptyAll
Sign_verify_errorMerchant signature verification errorAll
RequestMethod_not_postNot a POST requestAll
RequestContentType_not_jsonNot an application/json requestAll
RequestBody_is_nullThe request body is emptyAll
MerchantId_not_NumberMerchantId is not a numberAll
MerchantId_is_errorMerchant Id errorAll
Request_ip_notWhiteListRequest ip non-whitelistAll
Params_jsonFormat_errorRequest body json format errorAll
Params_xxx_RequiredParameter xxx is requiredAll
Params_xxx_errorParameter xxx errorAll
Params_accountNo_Format_isIncorrectThe bank account number format is incorrect (the length of the bank card number does not match the bank)Some countries
Merchant_amount_notEnoughMerchant balance is insufficientAll
Merchant_not_enabledMerchant is not enabledAll
Merchant_not_existMerchant does not existAll
Params_order_notExistThe platform order number does not existAll
Params_mchOrderNo_notExistThe merchant order number does not existAll
Params_mchOrderNo_repeatDuplicate merchant order numberAll
Channel_Maintenance_timeThe channel is under maintenance, please contact technical support for testing environmentAll
Tran_risk_interceptTransaction risk control interception, check whether the amount meets the restriction conditionsAll
Params_accountName_Maximum<40>charactersPayout (beneficiary) payee name is too longSome countries,MX is 40 characters
Params_idType_Exists_idCard_CPF_InvalidateCPF Number InvalidateBR
COLLECTION_ACCOUNT_DAY_LIMITThe number of times the payment card number reaches the daily limit limitAll
COLLECTION_NAME_DAY_LIMITThe number of times the payee name reaches the daily limit limitAll
LIMIT_MIN_AMOUNTThe order amount is less than the minimum amount limitAll
LIMIT_MAX_AMOUNTThe order amount is higher than the maximum amount limitAll
BLACK_LIST_USER_LIMITThe user is on the blacklistAll
Params_realName_not_contain_ChineseAccount names are not allowed to contain ChineseAll
Params_accountName_not_contain_ChineseAccount names are not allowed to contain ChineseAll
Params_accountNo_Clabe_InvalidateClabe is invalidMexico
Params_email_format_invalidThe email format is invalidMexico
Params_email_length_exceeds<64>charactersThe mailbox length exceeds 64 characters (the mailbox length should be kept below 64 characters)All

Released under the MIT License.