{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/transfers","auth":"required","settings":"","results":{"codes":[{"name":"","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","status":200}]},"params":[{"name":"dest","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f062319b"},{"name":"dest.paymentMethodType","type":"string","default":"","desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f062319a"},{"name":"dest.country","type":"string","default":"","desc":"`CN`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623199"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property `destCurrency`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623198"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623197"},{"name":"dest.paymentType","type":"string","default":"","desc":"Which channel the funds are delivered through - \"LOCAL_BANK_TRANSFER\" is currently the only supported value for China","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623196"},{"name":"dest.nameOnAccount","type":"string","default":"","desc":"Beneficiary name in Chinese characters","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623195"},{"name":"dest.accountNumber","type":"string","default":"","desc":"Beneficiary account number","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623194"},{"name":"dest.bankName","type":"string","default":"","desc":"Beneficiary bank name in Chinese characters","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623193"},{"name":"dest.branchName","type":"string","default":"","desc":"Beneficiary branch name in Chinese characters","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623192"},{"name":"dest.bankCity","type":"string","default":"","desc":"Beneficiary bank city in Chinese characters","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623191"},{"name":"dest.bankProvince","type":"string","default":"","desc":"Beneficiary bank province in Chinese characters","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623190"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":true,"in":"body","ref":"","_id":"5f27a196f61fb601f062318f"},{"name":"destCurrency","type":"string","default":"","desc":"Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed","required":true,"in":"body","ref":"","_id":"5f27a196f61fb601f062318e"},{"name":"destAmount","type":"string","default":"","desc":"Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.","required":true,"in":"body","ref":"","_id":"5f27a196f61fb601f062318d"},{"name":"message","type":"string","default":"","desc":"Optional message for transactions","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f062318c"},{"name":"referenceNumber","type":"string","default":"","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.","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f062318b"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f062318a"},{"name":"callbackUrl","type":"string","default":"","desc":"An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f0623189"}],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"πŸ‡¨πŸ‡³ Payouts to China","type":"endpoint","slug":"payouts-to-china","excerpt":"","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]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f27a196f61fb601f0623188","createdAt":"2020-08-03T05:33:11.010Z","user":"54ea9905a6f14f0d003e96e7","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Global Payouts","slug":"global-payouts","order":11,"from_sync":false,"reference":false,"_id":"5f276fd300e519001139200a","createdAt":"2020-08-03T02:00:51.725Z","version":"550f75de61d9d30d00af9e01","project":"550f74bb6fc8130d0038aad3","__v":0},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a","5f9a2cb79dafe500259281a7"],"_id":"550f75de61d9d30d00af9e01","__v":23,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":0,"parentDoc":null}

postπŸ‡¨πŸ‡³ Payouts to China


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
required
string
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:
string
Which channel the funds are delivered through - "LOCAL_BANK_TRANSFER" is currently the only supported value for China
dest.nameOnAccount:
required
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:
string
Beneficiary branch name in Chinese characters
dest.bankCity:
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
string
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))

Result Format


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]