{"_id":"56c72e537bb0fc0d00a973f0","user":"54eb883f4f94620d00789aaa","__v":17,"category":{"_id":"56c72df5b3625c0d00422c9e","__v":5,"pages":["56c72e13f795cf0d003ec16a","56c72e537bb0fc0d00a973f0","56c72e77dd0b310d00e82ef1","56c72ee4862f940d00564762","56ccfdb48fa8b01b00b8202c"],"version":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-19T15:00:05.865Z","from_sync":false,"order":6,"slug":"transfer-examples","title":"Payout Currencies"},"parentDoc":null,"version":{"_id":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","forked_from":"558b53f749dc4f0d00517de3","__v":8,"createdAt":"2015-06-29T01:17:40.214Z","releaseDate":"2015-06-29T01:17:40.214Z","categories":["55909cb433090f0d004d25d9","55909cb433090f0d004d25da","55909cb433090f0d004d25db","55909cb433090f0d004d25dc","56c72c00197f9f1700c811db","56c72df5b3625c0d00422c9e","56e1b646150ed52d0062c652","56e9fe9779708c0e002b6026","57312dc94245100e001743f4","57646a570742400e00c04701","5894c96f4d9c7e27002e42ba"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"githubsync":"","project":"558b53f749dc4f0d00517de0","updates":["5797fd09946a240e00ad0092"],"next":{"pages":[],"description":""},"createdAt":"2016-02-19T15:01:39.405Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n  \"dest\": {\n    \"paymentMethodType\":\"INTERNATIONAL_TRANSFER\",\n    \"country\": \"CN\",\n    \"currency\": \"CNY\",\n    \"beneficiaryType\": \"INDIVIDUAL\",\n    \"paymentType\" : \"LOCAL_BANK_TRANSFER\", // LOCAL_BANK_TRANSFER only\n    \"nameOnAccount\": \"εΌ δΈ‰\",\n    \"accountNumber\": \"0000000000000000\",\n    \"bankName\": \"δΈ­ε›½ε·₯ε•†ι“Άθ‘Œ\",\n    \"branchName\":\"δΈŠζ΅·εˆ†θ‘Œη”°ζž—ζ”―θ‘Œ\",\n    \"bankCity\":\"上桷\",\n    \"bankProvince\": \"上桷\"\n  },\n  \"sourceCurrency\": \"USD\",\n  \"destCurrency\": \"CNY\",\n  \"destAmount\": 10,\n  \"message\": \"CNY example\", // optional - note\n  \"referenceNumber\": \"\", // optional - reference number\n  \"autoConfirm\": \"true\", // optional - automatically confirms transfer\n  \"callbackUrl\": \"\" // optional - location where to receive callbacks\n}","language":"json"}]},"method":"post","results":{"codes":[{"code":"","language":"text"}]},"settings":"","auth":"required","params":[{"_id":"57dac8e20c5ef00e0019f739","ref":"","in":"body","required":true,"desc":"","default":"","type":"object","name":"dest"},{"_id":"57dac8e20c5ef00e0019f738","ref":"","in":"body","required":true,"desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","default":"","type":"string","name":"dest.paymentMethodType"},{"_id":"57dac8e20c5ef00e0019f737","ref":"","in":"body","required":true,"desc":"`CN`","default":"","type":"string","name":"dest.country"},{"_id":"57dac8e20c5ef00e0019f736","ref":"","in":"body","required":true,"desc":"Currency to deposit - must match root object property `destCurrency`","default":"","type":"string","name":"dest.currency"},{"_id":"57dac8e20c5ef00e0019f735","ref":"","in":"body","required":true,"desc":"`INDIVIDUAL` or `CORPORATE`","default":"","type":"string","name":"dest.beneficiaryType"},{"_id":"57dac8e20c5ef00e0019f734","ref":"","in":"body","required":true,"desc":"Which channel the funds are delivered through - \"LOCAL_BANK_TRANSFER\" is currently the only supported value for China","default":"","type":"string","name":"dest.paymentType"},{"_id":"5857fcd43ed9a719000c1278","ref":"","in":"body","required":false,"desc":"Beneficiary name in Chinese characters","default":"","type":"string","name":"dest.nameOnAccount"},{"_id":"57dac8e20c5ef00e0019f733","ref":"","in":"body","required":true,"desc":"Beneficiary account number","default":"","type":"string","name":"dest.accountNumber"},{"_id":"57dac8e20c5ef00e0019f732","ref":"","in":"body","required":true,"desc":"Beneficiary bank name in Chinese characters","default":"","type":"string","name":"dest.bankName"},{"_id":"57dac8e20c5ef00e0019f730","ref":"","in":"body","required":true,"desc":"Beneficiary branch name in Chinese characters","default":"","type":"string","name":"dest.branchName"},{"_id":"57dac8e20c5ef00e0019f72f","ref":"","in":"body","required":true,"desc":"Beneficiary bank city in Chinese characters","default":"","type":"string","name":"dest.bankCity"},{"_id":"57dac8e20c5ef00e0019f72e","ref":"","in":"body","required":true,"desc":"Beneficiary bank province in Chinese characters","default":"","type":"string","name":"dest.bankProvince"},{"_id":"57dac8e20c5ef00e0019f72d","ref":"","in":"body","required":true,"desc":"Currency to be debited from your account","default":"","type":"string","name":"sourceCurrency"},{"_id":"57dac8e20c5ef00e0019f72c","ref":"","in":"body","required":true,"desc":"Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed","default":"","type":"string","name":"destCurrency"},{"_id":"57dac8e20c5ef00e0019f72b","ref":"","in":"body","required":true,"desc":"Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.","default":"","type":"float","name":"destAmount"},{"_id":"57dac8e20c5ef00e0019f72a","ref":"","in":"body","required":false,"desc":"Optional message for transactions","default":"","type":"string","name":"message"},{"_id":"57dac8e20c5ef00e0019f729","ref":"","in":"body","required":false,"desc":"Optional reference number for transaction. Reference numbers are unique, so if you submit two transactions with the same reference number the second will be rejected.","default":"","type":"string","name":"referenceNumber"},{"_id":"5876f4fb3def3a0f00fe8473","ref":"","in":"body","required":false,"desc":"An optional parameter to automatically confirm the transfer order.","default":"","type":"string","name":"autoConfirm"},{"_id":"5876f4fb3def3a0f00fe8472","ref":"","in":"body","required":false,"desc":"An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))","default":"","type":"string","name":"callbackUrl"}],"url":"/transfers"},"isReference":false,"order":2,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**Payout Options**\",\n    \"0-1\": \"Banking Rails\",\n    \"1-0\": \"**Banking Coverage**\",\n    \"1-1\": \"All UnionPay supported banks\",\n    \"2-0\": \"**Delivery Time**\",\n    \"2-1\": \"24 hours\",\n    \"3-0\": \"**Personal/Individual Limits**\",\n    \"3-1\": \"Bank Accounts\\n- $50,000 per-year maximum\\n- Above RMB 200\",\n    \"4-1\": \"Bank Accounts\\n- Above RMB 200\",\n    \"4-0\": \"**Corporation/Business Limits**\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"usd-balance-cn-bank-account","type":"endpoint","title":"Payouts to πŸ‡¨πŸ‡³ CHINA"}

postPayouts to πŸ‡¨πŸ‡³ CHINA


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
required
object
dest.paymentMethodType:
required
string
Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object
dest.country:
required
string
`CN`
dest.currency:
required
string
Currency to deposit - must match root object property `destCurrency`
dest.beneficiaryType:
required
string
`INDIVIDUAL` or `CORPORATE`
dest.paymentType:
required
string
Which channel the funds are delivered through - "LOCAL_BANK_TRANSFER" is currently the only supported value for China
dest.nameOnAccount:
string
Beneficiary name in Chinese characters
dest.accountNumber:
required
string
Beneficiary account number
dest.bankName:
required
string
Beneficiary bank name in Chinese characters
dest.branchName:
required
string
Beneficiary branch name in Chinese characters
dest.bankCity:
required
string
Beneficiary bank city in Chinese characters
dest.bankProvince:
required
string
Beneficiary bank province in Chinese characters
sourceCurrency:
required
string
Currency to be debited from your account
destCurrency:
required
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed
destAmount:
required
float
Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.
message:
string
Optional message for transactions
referenceNumber:
string
Optional reference number for transaction. Reference numbers are unique, so if you submit two transactions with the same reference number the second will be rejected.
autoConfirm:
string
An optional parameter to automatically confirm the transfer order.
callbackUrl:
string
An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))

Examples


Documentation

[block:parameters] { "data": { "0-0": "**Payout Options**", "0-1": "Banking Rails", "1-0": "**Banking Coverage**", "1-1": "All UnionPay supported banks", "2-0": "**Delivery Time**", "2-1": "24 hours", "3-0": "**Personal/Individual Limits**", "3-1": "Bank Accounts\n- $50,000 per-year maximum\n- Above RMB 200", "4-1": "Bank Accounts\n- Above RMB 200", "4-0": "**Corporation/Business Limits**" }, "cols": 2, "rows": 5 } [/block]