docs/payout/supplemental-data-upload.md

# Submit supplementa data for CNY users

---

* Method: `POST`
* `/v3/payouts/supplemental`


### Request

|Field|M/C/O|Type|Description|
|---|---|---|---|
|invoiceId|M|String|Same `invoiceId` for the associated Payout transaction|
|customerNo|M|String|Payee ID, same value with the customerNo in Payout transaction|
|mode|M|String|Mandontary, value is `batch`|
|materials|M|Object List|The supplemental data informations|

###### Material

|Field|M/C/O|Type|Description|
|---|---|---|---|
|transactionNo|M|String|Payin Transaction ID/Order No./Reference ID|
|payerName|M|String|The Payer name of the original payment transaction, buyer's name|
|email|M|String|The buyer's email address|
|payerCountryCode|M|String|The buyer's country code, e.g. CN|
|tradeTime|M|String|The original trade order time|
|tradeCurrency|M|String|The original trade order currency|
|tradeAmount|M|String|The original trade order amount|
|goodsCarrier|M|String|The goods carrier|
|serviceDetail|M|String|The original order information, e.g. goods name, price, count.|
|serviceTime|M|String|Service time can be the original order time.| 

```json
{
    "merchantNo": "202333",
    "storeNo": "301854",
    "verifySign": "cba0a40794c2c76519a3b87679551a8e",
    "timestamp": "2023-02-17T22:02:16Z",
    "invoiceId": "917162d533644e3ed9c2cafd4299040e",
    "customerNo": "2000305228264750734154",
    "mode": "batch",
    "materials": [
    {
        "transactionNo": "302623160655346146",
        "payerName": "John Doe1",
        "email": "[email protected]",
        "payerCountryCode": "CA",
        "tradeTime": "2021-12-22T15:56:26Z",
        "tradeCurrency": "USD",
        "tradeAmount": "1000.00",
        "goodsCarrier": "Fedex",
        "serviceDetail": "Wine",
        "serviceTime": "2020-12-22T15:55:26Z"
    },
    {
        "transactionNo": "302623160655346147",
        "payerName": "John Doe2",
        "email": "[email protected]",
        "payerCountryCode": "US",
        "tradeTime": "2021-12-22T16:56:26Z",
        "tradeCurrency": "USD",
        "tradeAmount": "2001.00",
        "goodsCarrier": "德邦快递",
        "serviceDetail": "Cigar",
        "serviceTime": "2021-12-22T17:55:26Z"
    }]
}
```

### Response

```json
{
    "result":
    {
        "records": [
        {
            "amount": "1000.00",
            "paymentId": "302623160655346146",
            "payerName": "John Doe1",
            "invoiceId": "917162d533644e3ed9c2cafd4299040e",
            "currency": "USD",
            "status": "succeeded"
        },
        {
            "amount": "2001.00",
            "paymentId": "302623160655346147",
            "payerName": "John Doe2",
            "invoiceId": "917162d533644e3ed9c2cafd4299040e",
            "currency": "USD",
            "status": "succeeded"
        }],
        "transactionNo": "305452742174470834",
        "invoiceId": "917162d533644e3ed9c2cafd4299040e"
    },
    "ret_msg": "created",
    "ret_code": "000100"
}
```