Errors

Every error a China payout returns, what causes it, and the fix.

Search this page for the message the API returned.

POST /send runs its checks in one order and stops at the first failure: the schema, then the counterparty, then the sender, then the documents.

Counterparty errors

HTTPMessageerrorTypeFix
404Counterparty not found: <id>The id does not belong to your business. Check the id.
422Counterparty <id> is pending verification and cannot be used for payouts.COUNTERPARTY_PENDING_VERIFICATIONThe partner registration is not finished. Poll until active. Allow 48 hours.
422Counterparty <id> failed verification and cannot be used for payouts.COUNTERPARTY_VERIFICATION_FAILEDNo partner accepted the account. Create a new counterparty.
422Counterparty <id> is blacklisted and cannot be used for payouts. Reason: <reason>COUNTERPARTY_BLACKLISTEDThe block is one-way. Create a new counterparty.
422Counterparty is of type <A>, but the payout request is for type <B>.COUNTERPARTY_TYPE_MISMATCHSend paymentScheme=cnaps. See below.
422Counterparty <id> has neither an account number nor an IBAN.The record has no account number. Create a new counterparty.
500Unable to verify counterparty: <id>Retry with the same customerReference.

How the type mismatch happens. Fincra builds the type it expects from your request.

expected type = UPPERCASE(destinationCurrency + "_" + paymentScheme)

CNY and cnaps give CNY_CNAPS. A missing paymentScheme gives CNY_, which matches nothing.

Sender errors

HTTPMessageFix
422Invalid senderId provided for FCY payouts.The sender does not exist. Check the id.
403Invalid senderId provided for FCY payouts.The sender belongs to another business.
403Individual senders of Chinese nationality are not permitted for CNY payouts.See below.
403Sender is blacklisted from making transactions.The sender is on your block list.
403Sender is not approved to make transactions.The verification is not approved, or the sender is a local-currency sender.

The rule for Chinese individuals. Fincra rejects the payout when all three are true: the sender is an individual, the countryOfOrigin of the sender is CN, and the entityType of the counterparty is individual.

A Chinese individual sender can pay a business counterparty. A Chinese business sender has no limit. An individual sender with no recorded country of origin has no limit.

CNY is the only currency that accepts an individual sender at all. USD, EUR and GBP return Individual senders currently not supported for <CURRENCY> payout.

Schema errors

MessageCause
"counterpartyId" is requiredYou did not send counterpartyId.
"business" length must be 24 characters longThe business id is the wrong length.
Purpose of fund is requiredYou did not send purposeOfFund.
"relationshipWithBeneficiary" is requiredYou did not send the relationship.
"<field>" is not allowedYou sent a field the endpoint does not accept.
"amount" must be an integerThe source currency has no decimal places.
"transactionId" is requiredaction is authenticate and the transaction id is absent.
Cannot continue, Duplicate Customer Reference PassedYou used this customerReference before.

China payout errors

MessageCause
purposeOfFund is required for CNY/CNH payoutsYou did not send purposeOfFund.
purposeOfFund is not supported for CNY/CNH payoutsThe purpose is not one of the 20 CNY values.
"additionalPayoutDetails" is requiredThe trade details or the salary details are absent.
"additionalPayoutDetails" is not allowedYou sent the object on a payout that is not CNY.
platform requires at least one of name or urlAn order has no platform name and no shop address.
"amount" is required when there is more than one orderYou sent many orders and one has no amount. It is optional only on a single order.
The sum of order amounts (<total>) must equal the payout amount (<amount>)Same-currency payout. The amounts do not add up.
The sum of order amounts (<total>) must equal the amount the beneficiary receives (<amount> <currency>).Conversion. The amounts do not add up. Order amounts are in CNY, so calculate them from the destination amount of the quote.
"orderedAt" must be a valid date or epoch-milliseconds timestampFincra cannot read the order date.
"quantity" must be less than or equal to 999The item quantity is too large.

Counterparty creation errors

Every rule on Create a China counterparty returns 400 with the code validation_error. The message names the field.

Message
address.country must be CN for CNY beneficiaries — CNAPS pays onshore Chinese accounts only
phone must be a valid Chinese mobile number for CNY beneficiaries (e.g. +8613800138000)
<field> must be in Chinese characters for CNY beneficiaries
document is required for individual CNY beneficiaries
document.type must be national_id for individual CNY beneficiaries
document.number is required for individual CNY beneficiaries
phone is required for individual CNY beneficiaries
name must be the registered Chinese legal name for CNY beneficiaries
registrationNumber is required for businesses incorporated in China
registrationNumber must be a valid 18-character Unified Social Credit Code for businesses incorporated in China
specialEconomicZone is required for businesses incorporated in China
counterparty already exists with the same account details

Authentication errors

HTTPCode
401api_key_missing
401api_key_invalid
401invalid_ip_address
401kyb_not_approved

The IP check and the Know Your Business check run in production only.

Next: Test your integration.


Did this page help you?