{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/transfers","auth":"required","settings":"","results":{"codes":[]},"params":[{"name":"dest","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8027"},{"name":"dest.paymentMethodType","type":"string","default":"","desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8026"},{"name":"dest.country","type":"string","default":"","desc":"Country of beneficiary bank","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801e"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property destCurrency","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801f"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801d"},{"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":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801a"},{"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":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801b"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8019"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8017"},{"name":"message","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8018"},{"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":"5f27a326ad490202276f8016"},{"name":"dest.beneficiaryAddress","type":"string","default":"","desc":"Beneficiary street address","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195df"},{"name":"dest.beneficiaryAddress2","type":"string","default":"","desc":"Beneficiary street address 2","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195de"},{"name":"dest.beneficiaryCity","type":"string","default":"","desc":"Beneficiary city","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195dd"},{"name":"dest.beneficiaryState","type":"string","default":"","desc":"Beneficiary state","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195dc"},{"name":"dest.beneficiaryPostal","type":"string","default":"","desc":"Beneficiary postal zip code","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195db"},{"name":"dest.beneficiaryPhoneNumber","type":"string","default":"","desc":"Required for Individual","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195da"},{"name":"dest.beneficiaryLandlineNumber","type":"string","default":"","desc":"Required for Business","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d9"},{"name":"dest.beneficiaryEinTin","type":"string","default":"","desc":"Required for Business","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d8"},{"name":"dest.beneficiaryEmailAddress","type":"string","default":"","desc":"Required for Business","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d7"},{"name":"dest.beneficiaryDobDay","type":"string","default":"","desc":"Beneficiary date of birth day","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d6"},{"name":"dest.beneficiaryDobMonth","type":"string","default":"","desc":"Beneficiary date of birth month","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d5"},{"name":"dest.beneficiaryDobYear","type":"string","default":"","desc":"Beneficiary date of birth year","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d4"},{"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":"5f27a60c68ec2e01dde195d3"},{"name":"dest.beneficiaryCompanyName","type":"string","default":"","desc":"Required for Business","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d2"},{"name":"dest.firstNameOnAccount","type":"string","default":"","desc":"Beneficiary's first name","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d1"},{"name":"dest.lastNameOnAccount","type":"string","default":"","desc":"Beneficiary's last name","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195d0"},{"name":"dest.accountNumber","type":"string","default":"","desc":"Beneficiary account number","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195cf"},{"name":"dest.routingNumber","type":"string","default":"","desc":"Beneficiary routing number","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195ce"},{"name":"dest.accountType","type":"string","default":"","desc":"`CHECKING` or `SAVINGS`","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195cd"},{"name":"dest.bankName","type":"string","default":"","desc":"Beneficiary bank name","required":false,"in":"body","ref":"","_id":"5f27a60c68ec2e01dde195cc"}],"examples":{"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"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"πŸ‡ΊπŸ‡Έ Payouts to USA","type":"endpoint","slug":"payouts-to-usa","excerpt":"","body":"","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f27a4445fedad005c83814d","createdAt":"2020-08-03T05:44:36.415Z","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"],"_id":"550f75de61d9d30d00af9e01","__v":22,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":1,"parentDoc":null}

postπŸ‡ΊπŸ‡Έ Payouts to USA


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
object
dest.paymentMethodType:
string
Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object
dest.country:
string
Country of beneficiary bank
dest.currency:
string
Currency to deposit - must match root object property destCurrency
dest.beneficiaryType:
string
`INDIVIDUAL` or `CORPORATE`
destCurrency:
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed
destAmount:
string
Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.
sourceCurrency:
string
Currency to be debited from your account
autoConfirm:
string
An optional parameter to automatically confirm the transfer order.
message:
string
callbackUrl:
string
An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))
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:
string
Required for Individual
dest.beneficiaryLandlineNumber:
string
Required for Business
dest.beneficiaryEinTin:
string
Required for Business
dest.beneficiaryEmailAddress:
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:
string
Required for Business
dest.firstNameOnAccount:
string
Beneficiary's first name
dest.lastNameOnAccount:
string
Beneficiary's last name
dest.accountNumber:
string
Beneficiary account number
dest.routingNumber:
string
Beneficiary routing number
dest.accountType:
string
`CHECKING` or `SAVINGS`
dest.bankName:
string
Beneficiary bank name

Examples