> ## Documentation Index
> Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

We support payout to China in CNY through the following networks:

1. **UnionPay** — [Payout to bank account](https://developer.tazapay.com/payouts/local-guides/china-cny/unionpay)
   1. B2C payroll only
   2. C2C Self and family support

2. **CNAPS** — [Payout to bank account](https://developer.tazapay.com/payouts/local-guides/china-cny/cnaps)
   1. B2B and B2C physical goods only
   2. B2B services

3. **Alipay** — [Payout to Alipay linked phone number](https://developer.tazapay.com/payouts/local-guides/china-cny/alipay)
   1. C2C Self and family support
   2. B2C payroll only; freelancer payments are not allowed

## Things to note

1. For physical goods payouts, it is required to share the logistics provider, tracking number, and item details mentioned below.
2. For B2B services payout, it is required to upload invoice details.
3. For payroll merchants, an approval process with our partner is required.

All granular details are mentioned on the network pages linked above.

## Invoice Line Items (`items`)

The `items` field allows you to attach invoice line items to a payout. It is **optional** for most corridors, but is **strongly advised** when:

* The payout purpose is **PYR022** (General Goods Trades - Offline trade), **and**
* The destination corridor is **CN-CNY local**.

Chinese regulators may require itemised goods details to verify cross-border trade payouts. Providing `items` with PYR022 payouts reduces the likelihood of compliance holds.

### Item Object Fields

| Field         | Type    | Required | Validation        | Description                                                                                                                |
| ------------- | ------- | -------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `name`        | string  | Yes      | max 512 chars     | Name of the goods item. Recommended format: `E-commerce platform \| Product details \| Buyer's country \| Buyer's address` |
| `quantity`    | integer | Yes      | ≥ 1               | Number of units                                                                                                            |
| `amount`      | integer | Yes      | > 0, minor units  | Unit price in the payout currency's minor units                                                                            |
| `category`    | string  | Yes      | must be `"Goods"` | Item category — currently only `Goods` is accepted                                                                         |
| `description` | string  | No       | max 512 chars     | Optional free-text description of the item                                                                                 |

> **Note:** `amount` is the **unit price** in minor units (e.g., `10000` = CNY 100.00). Multiply by `quantity` to get the line total.

# Sample Request Body

```bash theme={null}
curl --request POST \
     --url https://service-sandbox.tazapay.com/v3/payout \
     --header 'accept: application/json' \
     --header 'authorization: Basic XXXXXXxxxxxxxxXXXXX' \
     --header 'content-type: application/json' \
     --data '
{
  "beneficiary_details": {
    "destination_details": {
      "type": "bank",
      "bank": {
        "bank_codes": {
          "swift_code": "Testswift",
          "cnaps": "2749827482"
        },
        "account_number": "124353",
        "bank_name": "圳市腾",
        "country": "CN",
        "currency": "CNY"
      }
    },
    "name_local": "深圳市腾***有限公司",
    "name": "John Doe",
    "type": "individual",
    "national_identification_number": "1234567890" 
  },
  "purpose": "PYR028",
  "logistics_tracking_details": {
    "logistics_provider_name": "CargoWave",
    "logistics_provider_code": "CGW",
    "tracking_number": "924U798274"
  },
  "amount": 10000,
  "currency": "CNY",
  "holding_currency": "USD",
  "documents": [
    {
      "type": "invoice",
      "url": "sample_url"
    },
    {
      "type": "contract",
      "url": "sample_url"
    }
  ],
  "items": [
    {
      "name": "Electronic Components",
      "quantity": 5,
      "amount": 2000,
      "category": "Goods",
      "description": "Resistors and capacitors batch #A12"
    }
  ]
}
'
```

# Sample Response Body

```json theme={null}
{
    "status": "success",
    "message": "",
    "data": {
        "amount": 10000,
        "balance_transaction": "btr_crv2q2hh1l071n2fjb70",
        "beneficiary": "bnf_crv2pf1h1l071n2fjapg",
        "beneficiary_details": {
            "address": null,
            "destination": "",
            "destination_details": {
                "bank": {
                    "account_number": "124353",
                    "account_type": "",
                    "bank_codes": {
                        "swift_code": "Testswift",
                        "cnaps": "2749827482"
                    },
                    "bank_name": "圳市腾",
                    "country": "CN",
                    "currency": "CNY",
                    "firc_required": false,
                    "purpose_code": ""
                },
                "type": "bank"
            },
            "national_identification_number": "361723721",
            "logistics_tracking_details": {
                "logistics_provider": {
                    "name": "Cargowave",
                    "code": "CGW"
                },
                "tracking_number": "924U798274"
            },
            "email": "",
            "name_local": "深圳市腾***有限公司",
            "name": "John Doe",
            "phone": null,
            "tax_id": "",
            "type": "individual"
        },
        "charge_type": "",
        "created_at": "2024-10-03T05:35:06.796479Z",
        "currency": "CNY",
        "documents": [
            {
                "type": "invoice",
                "url": "sample_url"
            },
            {
                "type": "contract",
                "url": "sample_url"
            }
        ],
        "holding_currency": "USD",
        "holding_fx_transaction": {
            "exchange_rate": 6.735621,
            "final": {
                "amount": 10000,
                "currency": "CNY"
            },
            "id": "fx_crv2q2gdj96g452dfo0g",
            "initial": {
                "amount": 1485,
                "currency": "USD"
            },
            "object": "fx_transaction"
        },
        "id": "pot_crv2q2hh1l071n2fjb6g",
        "metadata": null,
        "mt103": "",
        "object": "payout",
        "payout_fx_transaction": {
            "exchange_rate": 1,
            "final": {
                "amount": 10000,
                "currency": "CNY"
            },
            "id": "fx_crv2q2gdj96g452dfo00",
            "initial": {
                "amount": 10000,
                "currency": "CNY"
            },
            "object": "fx_transaction"
        },
        "purpose": "PYR007",
        "reference_id": "",
        "statement_descriptor": "",
        "status": "processing",
        "status_description": "",
        "tracking_details": null,
        "transaction_description": "",
        "type": "local"
    }
}
```