{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transfers","auth":"required","method":"post","params":[{"name":"dest","type":"object","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a6"},{"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":"5a1c879facac6b001e6674a5"},{"name":"dest.country","type":"string","default":"","desc":"Country of beneficiary bank","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a4"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property 'destCurrency'","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a3"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a2"},{"name":"dest.beneficiaryAddress","type":"string","default":"","desc":"Beneficiary street address","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a1"},{"name":"dest.beneficiaryAddress2","type":"string","default":"","desc":"Beneficiary street address 2","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e6674a0"},{"name":"dest.beneficiaryCity","type":"string","default":"","desc":"Beneficiary city","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66749f"},{"name":"dest.beneficiaryState","type":"string","default":"","desc":"Beneficiary state","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66749e"},{"name":"dest.beneficiaryPostal","type":"string","default":"","desc":"Beneficiary postal zip code","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66749d"},{"name":"dest.beneficiaryPhoneNumber","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e66749c"},{"name":"dest.beneficiaryLandlineNumber","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"5a1dbb94e9c397002aa68905"},{"name":"dest.beneficiaryEinTin","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"5a1dbb94e9c397002aa68904"},{"name":"dest.beneficiaryEmailAddress","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"5a1dbb94e9c397002aa68903"},{"name":"dest.beneficiaryDobDay","type":"string","default":"","desc":"Beneficiary date of birth day","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66749b"},{"name":"dest.beneficiaryDobMonth","type":"string","default":"","desc":"Beneficiary date of birth month","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66749a"},{"name":"dest.beneficiaryDobYear","type":"string","default":"","desc":"Beneficiary date of birth year","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e667499"},{"name":"dest.paymentType","type":"string","default":"","desc":"Which channel the funds are delivered through (e.g. `LOCAL_BANK_TRANSFER'","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e667498"},{"name":"dest.beneficiaryCompanyName","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"5a1dbb94e9c397002aa68902"},{"name":"dest.firstNameOnAccount","type":"string","default":"","desc":"Beneficiary's first name","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e667497"},{"name":"dest.lastNameOnAccount","type":"string","default":"","desc":"Beneficiary's last name","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e667496"},{"name":"dest.accountNumber","type":"string","default":"","desc":"Beneficiary account number","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e667495"},{"name":"dest.routingNumber","type":"string","default":"","desc":"Beneficiary routing number","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e667494"},{"name":"dest.accountType","type":"string","default":"","desc":"`CHECKING` or `SAVINGS`","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e667493"},{"name":"dest.bankName","type":"string","default":"","desc":"Beneficiary bank name","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e667492"},{"name":"destAmount","type":"float","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":"5a1c879facac6b001e667491"},{"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":"5a1c879facac6b001e667490"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":true,"in":"body","ref":"","_id":"5a1c879facac6b001e66748f"},{"name":"message","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a1c879facac6b001e66748e"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5a26e9e9f510c3001e47640d"},{"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":"5a26e9e9f510c3001e47640c"}],"results":{"codes":[]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Payouts to πŸ‡ΊπŸ‡Έ  USA","type":"endpoint","slug":"br-balance-us-bank-account","excerpt":"","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"dest\\\": {\\n    \\\"paymentMethodType\\\":\\\"INTERNATIONAL_TRANSFER\\\",\\n    \\\"country\\\": \\\"US\\\",\\n    \\\"currency\\\": \\\"USD\\\",\\n    \\\"beneficiaryType\\\": \\\"INDIVIDUAL\\\",\\n    \\\"beneficiaryAddress\\\": \\\"112 Brannan St\\\",\\n    \\\"beneficiaryAddress2\\\": \\\"\\\", //Optional\\n    \\\"beneficiaryCity\\\": \\\"San Francisco\\\",\\n    \\\"beneficiaryState\\\": \\\"CA\\\",\\n    \\\"beneficiaryPostal\\\": \\\"94108\\\",\\n    \\\"beneficiaryPhoneNumber\\\": \\\"+14102239203\\\",\\n    \\\"beneficiaryDobDay\\\": \\\"15\\\",\\n    \\\"beneficiaryDobMonth\\\":\\\"12\\\",\\n    \\\"beneficiaryDobYear\\\":\\\"1989\\\",\\n    \\\"paymentType\\\" : \\\"LOCAL_BANK_WIRE\\\",\\n    \\\"firstNameOnAccount\\\": \\\"Billy-Bob\\\",\\n    \\\"lastNameOnAccount\\\":\\\"Jones\\\",\\n    \\\"accountNumber\\\": \\\"0000000000000\\\",\\n    \\\"routingNumber\\\": \\\"0000000000\\\",\\n    \\\"accountType\\\": \\\"CHECKING\\\", // CHECKING or SAVINGS\\n    \\\"bankName\\\": \\\"Bank of America\\\"\\n  },\\n  \\\"sourceCurrency\\\": \\\"BRL\\\",\\n  \\\"destCurrency\\\": \\\"USD\\\",\\n  \\\"destAmount\\\": 10,\\n  \\\"message\\\":\\\"USD Personal example\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56ccfdb48fa8b01b00b8202c","parentDoc":null,"__v":19,"project":"558b53f749dc4f0d00517de0","createdAt":"2016-02-24T00:47:48.546Z","githubsync":"","user":"54ea9905a6f14f0d003e96e7","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["55909cb433090f0d004d25d9","55909cb433090f0d004d25da","55909cb433090f0d004d25db","55909cb433090f0d004d25dc","56c72c00197f9f1700c811db","56c72df5b3625c0d00422c9e","56e1b646150ed52d0062c652","56e9fe9779708c0e002b6026","57312dc94245100e001743f4","57646a570742400e00c04701","5894c96f4d9c7e27002e42ba"],"_id":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","releaseDate":"2015-06-29T01:17:40.214Z","createdAt":"2015-06-29T01:17:40.214Z","forked_from":"558b53f749dc4f0d00517de3","__v":8},"category":{"sync":{"isSync":false,"url":""},"pages":["56c72e13f795cf0d003ec16a","56c72e537bb0fc0d00a973f0","56c72e77dd0b310d00e82ef1","56c72ee4862f940d00564762","56ccfdb48fa8b01b00b8202c"],"title":"Payout Currencies","slug":"transfer-examples","order":6,"from_sync":false,"reference":false,"_id":"56c72df5b3625c0d00422c9e","__v":5,"version":"55909cb433090f0d004d25d8","createdAt":"2016-02-19T15:00:05.865Z","project":"558b53f749dc4f0d00517de0"}}

postPayouts to πŸ‡ΊπŸ‡Έ USA


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
Country of beneficiary bank
dest.currency:
required
string
Currency to deposit - must match root object property 'destCurrency'
dest.beneficiaryType:
required
string
`INDIVIDUAL` or `CORPORATE`
dest.beneficiaryAddress:
string
Beneficiary street address
dest.beneficiaryAddress2:
string
Beneficiary street address 2
dest.beneficiaryCity:
string
Beneficiary city
dest.beneficiaryState:
string
Beneficiary state
dest.beneficiaryPostal:
string
Beneficiary postal zip code
dest.beneficiaryPhoneNumber:
required
string
Required for Individual
dest.beneficiaryLandlineNumber:
required
string
Required for Business
dest.beneficiaryEinTin:
required
string
Required for Business
dest.beneficiaryEmailAddress:
required
string
Required for Business
dest.beneficiaryDobDay:
string
Beneficiary date of birth day
dest.beneficiaryDobMonth:
string
Beneficiary date of birth month
dest.beneficiaryDobYear:
string
Beneficiary date of birth year
dest.paymentType:
string
Which channel the funds are delivered through (e.g. `LOCAL_BANK_TRANSFER'
dest.beneficiaryCompanyName:
required
string
Required for Business
dest.firstNameOnAccount:
required
string
Beneficiary's first name
dest.lastNameOnAccount:
required
string
Beneficiary's last name
dest.accountNumber:
required
string
Beneficiary account number
dest.routingNumber:
required
string
Beneficiary routing number
dest.accountType:
required
string
`CHECKING` or `SAVINGS`
dest.bankName:
string
Beneficiary bank name
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.
destCurrency:
required
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed
sourceCurrency:
required
string
Currency to be debited from your account
message:
string
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))

Documentation

[block:code] { "codes": [ { "code": "{\n \"dest\": {\n \"paymentMethodType\":\"INTERNATIONAL_TRANSFER\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"beneficiaryType\": \"INDIVIDUAL\",\n \"beneficiaryAddress\": \"112 Brannan St\",\n \"beneficiaryAddress2\": \"\", //Optional\n \"beneficiaryCity\": \"San Francisco\",\n \"beneficiaryState\": \"CA\",\n \"beneficiaryPostal\": \"94108\",\n \"beneficiaryPhoneNumber\": \"+14102239203\",\n \"beneficiaryDobDay\": \"15\",\n \"beneficiaryDobMonth\":\"12\",\n \"beneficiaryDobYear\":\"1989\",\n \"paymentType\" : \"LOCAL_BANK_WIRE\",\n \"firstNameOnAccount\": \"Billy-Bob\",\n \"lastNameOnAccount\":\"Jones\",\n \"accountNumber\": \"0000000000000\",\n \"routingNumber\": \"0000000000\",\n \"accountType\": \"CHECKING\", // CHECKING or SAVINGS\n \"bankName\": \"Bank of America\"\n },\n \"sourceCurrency\": \"BRL\",\n \"destCurrency\": \"USD\",\n \"destAmount\": 10,\n \"message\":\"USD Personal example\"\n}", "language": "json" } ] } [/block]