3. Add a China beneficiary

POST /v1/payments/beneficiaries

curl -X POST https://api-staging.checker.finance/v1/payments/beneficiaries \
  -H "X-Api-Key: $API_KEY" \
  -H "X-Timestamp: $TIMESTAMP" \
  -H "X-Nonce: $(uuidgen)" \
  -H "X-Signature: $SIGNATURE" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "BUSINESS",
    "business_name": "Shanghai Trading Co",
    "address": {
      "line1": "88 Century Avenue",
      "city": "Shanghai",
      "postal_code": "200120",
      "country": "CN"
    },
    "payment_details": {
      "bank_name": "Citibank (China) Co., Ltd.",
      "account_name": "Shanghai Trading Co",
      "currency": "USD",
      "bank_country_code": "CN",
      "swift_code": "CITICNSXXXX",
      "account_number": "6222000000000088"
    }
  }'

Response — 201 Created:

{
  "beneficiary_id": "ben_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "business_name": "Shanghai Trading Co",
  "type": "BUSINESS",
  "status": "PENDING",
  "payment_details": {
    "bank_name": "Citibank (China) Co., Ltd.",
    "account_name": "Shanghai Trading Co",
    "currency": "USD",
    "bank_country_code": "CN"
  }
}

Notes:

  • Both address.country and payment_details.bank_country_code must be CN, and currency must be USD.
  • swift_code and account_number are required. Not every China bank is supported; an unsupported bank, an unrecognised bank name, or an invalid account number is rejected at creation.
  • customer_id is optional here. When you omit it, pass customer_id on the withdrawal instead.
  • A beneficiary is PENDING until confirmed, then ACTIVE.

Did this page help you?