{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/paymentMethods","auth":"required","params":[{"name":"owner","type":"string","default":"","desc":"Wallet ID (e.g. wallet:12345)","required":false,"in":"body","ref":"","_id":"5adf6ac80d03070003a2f99a"},{"name":"paymentMethodType","type":"string","default":"","desc":"INTERNATIONAL_TRANSFER","required":true,"in":"body","ref":"","_id":"58dd675d85a2a02f00051c2b"},{"name":"paymentType","type":"string","default":"","desc":"`LOCAL_BANK_WIRE`","required":true,"in":"body","ref":"","_id":"58dd66931477020f002d4af7"},{"name":"currency","type":"string","default":"","desc":"3 letter currency code","required":true,"in":"body","ref":"","_id":"58dd7205c751371b00ba45c8"},{"name":"country","type":"string","default":"","desc":"alpha-2 country code","required":true,"in":"body","ref":"","_id":"58dd7205c751371b00ba45c7"},{"name":"beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` | `CORPORATE`","required":true,"in":"body","ref":"","_id":"58dd6ff885a2a02f00051d96"},{"name":"nameOnAccount","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58e30b90a1d8c70f00cae1d0"},{"name":"firstNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d8b"},{"name":"lastNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d8a"},{"name":"beneficiaryCompanyName","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"58ddba0375b5b20f00fa65bf"},{"name":"beneficiaryEinTin","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"58ddba0375b5b20f00fa65be"},{"name":"beneficiaryAddress","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4af1"},{"name":"beneficiaryAddress2","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4af0"},{"name":"beneficiaryCity","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4aef"},{"name":"beneficiaryPostal","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4aee"},{"name":"beneficiaryPhoneNumber","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"58dd66931477020f002d4aed"},{"name":"beneficiaryLandlineNumber","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"58ddba0375b5b20f00fa65bd"},{"name":"beneficiaryState","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4aec"},{"name":"beneficiaryEmailAddress","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d86"},{"name":"beneficiaryDobDay","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d84"},{"name":"beneficiaryDobMonth","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d83"},{"name":"beneficiaryDobYear","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"58dd6fad85a2a02f00051d82"},{"name":"accountNumber","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"58dd66931477020f002d4af5"},{"name":"routingNumber","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"58dd66931477020f002d4af4"},{"name":"accountType","type":"string","default":"","desc":"`CHECKING` | `SAVINGS`","required":false,"in":"body","ref":"","_id":"58dd66931477020f002d4af6"},{"name":"chargeablePM","type":"boolean","default":"","desc":"set to True","required":true,"in":"body","ref":"","_id":"5a1c5d3723a889002a05d45c"}],"results":{"codes":[{"name":"","code":"//the id is also an SRN of the format paymentmethod:<id>\n{\n id:<id>,\n name:<name>,\n status:\"AWAITING_FOLLOWUP | AWAITING_DEPOSIT_VERIFICATION | ACTIVE | REJECTED |  DISABLED | PENDING\",\n chargeableCurrencies:[\"USD\"],\n depositableCurrencies:[\"USD\"],\n chargeFeeSchedule:[...],\n depositFeeSchedule:[...],\n minCharge:0.0,\n maxCharge:0.0,\n minDeposit:0.0,\n maxDeposit:0.0\n}\n ","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"// This is going to be your user's bank information. We take this as a way to validate that they're the sender of the payment. It allows us to know where to expect the payment to be coming from.\n{\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\", // LOCAL_BANK_WIRE\n    \"firstNameOnAccount\": \"Billy-Bob\",\n    \"lastNameOnAccount\":\"Jones\",\n    \"accountNumber\": \"0000000000000\",\n    \"routingNumber\": \"0000000000\",\n    \"accountType\": \"CHECKING\", //CHECKING or SAVINGS\n  \t\"chargeablePM\": \"true\"\n}\n\n// This is going to be your corporation's bank information. We take this as a way to validate that they're the sender of the payment. It allows us to know where to expect the payment to be coming from.\n\n{\n    \"paymentMethodType\":\"INTERNATIONAL_TRANSFER\",\n    \"country\": \"US\",\n    \"currency\": \"USD\",\n    \"beneficiaryType\": \"CORPORATE\",\n    \"beneficiaryCompanyName\":\"\",\n    \"beneficiaryAddress\": \"112 Brannan St\",\n    \"beneficiaryAddress2\": \"\", //Optional\n    \"beneficiaryCity\": \"San Francisco\",\n    \"beneficiaryState\": \"CA\",\n    \"beneficiaryPostal\": \"94108\",\n    \"beneficiaryLandlineNumber\":\"+123464542947\",\n    \"beneficiaryEmailAddress\":\"tes:::at:::sendwyre.com\",\n    \"beneficiaryEinTin\":\"00000000\",\n    \"beneficiaryDobDay\": \"15\", //Date of Incorporation\n    \"beneficiaryDobMonth\":\"12\", //Date of Incorporation\n    \"beneficiaryDobYear\":\"1989\", //Date of Incorporation\n    \"paymentType\" : \"LOCAL_BANK_WIRE\", // LOCAL_BANK_WIRE\n    \"accountType\": \"CHECKING\", //CHECKING or SAVINGS\n    \"accountNumber\": \"0000000000000\",\n    \"routingNumber\": \"0000000000\",\n  \t\"chargeablePM\": \"true\"\n  }","language":"json"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Add Bank Account","type":"endpoint","slug":"deposit","excerpt":"","body":"","updates":[],"order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"58dc68c27e03800f00d00995","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Depositing Funds","slug":"depositing-funds","order":5,"from_sync":false,"reference":false,"_id":"57312dc94245100e001743f4","__v":0,"createdAt":"2016-05-10T00:39:37.949Z","project":"558b53f749dc4f0d00517de0","version":"55909cb433090f0d004d25d8"},"project":"558b53f749dc4f0d00517de0","user":"56cdfe00e538330b0021ab76","parentDoc":null,"__v":20,"createdAt":"2017-03-30T02:09:06.062Z","githubsync":"","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}}

postAdd Bank Account


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

owner:
string
Wallet ID (e.g. wallet:12345)
paymentMethodType:
required
string
INTERNATIONAL_TRANSFER
paymentType:
required
string
`LOCAL_BANK_WIRE`
currency:
required
string
3 letter currency code
country:
required
string
alpha-2 country code
beneficiaryType:
required
string
`INDIVIDUAL` | `CORPORATE`
nameOnAccount:
string
firstNameOnAccount:
required
string
Required for Individual
lastNameOnAccount:
required
string
Required for Individual
beneficiaryCompanyName:
required
string
Required for Business
beneficiaryEinTin:
required
string
Required for Business
beneficiaryAddress:
string
beneficiaryAddress2:
string
beneficiaryCity:
string
beneficiaryPostal:
string
beneficiaryPhoneNumber:
required
string
Required for Individual
beneficiaryLandlineNumber:
required
string
Required for Business
beneficiaryState:
string
beneficiaryEmailAddress:
required
string
Required for Business
beneficiaryDobDay:
integer
beneficiaryDobMonth:
integer
beneficiaryDobYear:
integer
accountNumber:
required
string
routingNumber:
required
string
accountType:
string
`CHECKING` | `SAVINGS`
chargeablePM:
required
boolean
set to True

Examples


Result Format