{"_id":"58dc68c27e03800f00d00995","category":{"_id":"57312dc94245100e001743f4","__v":0,"project":"558b53f749dc4f0d00517de0","version":"55909cb433090f0d004d25d8","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-10T00:39:37.949Z","from_sync":false,"order":5,"slug":"depositing-funds","title":"Depositing Funds"},"project":"558b53f749dc4f0d00517de0","user":"56cdfe00e538330b0021ab76","parentDoc":null,"__v":20,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-30T02:09:06.062Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","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 ","name":""}]},"settings":"","examples":{"codes":[{"language":"json","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  }"}]},"method":"post","auth":"required","params":[{"_id":"5adf6ac80d03070003a2f99a","ref":"","in":"body","required":false,"desc":"Wallet ID (e.g. wallet:12345)","default":"","type":"string","name":"owner"},{"_id":"58dd675d85a2a02f00051c2b","ref":"","in":"body","required":true,"desc":"INTERNATIONAL_TRANSFER","default":"","type":"string","name":"paymentMethodType"},{"_id":"58dd66931477020f002d4af7","ref":"","in":"body","required":true,"desc":"`LOCAL_BANK_WIRE`","default":"","type":"string","name":"paymentType"},{"_id":"58dd7205c751371b00ba45c8","ref":"","in":"body","required":true,"desc":"3 letter currency code","default":"","type":"string","name":"currency"},{"_id":"58dd7205c751371b00ba45c7","ref":"","in":"body","required":true,"desc":"alpha-2 country code","default":"","type":"string","name":"country"},{"_id":"58dd6ff885a2a02f00051d96","ref":"","in":"body","required":true,"desc":"`INDIVIDUAL` | `CORPORATE`","default":"","type":"string","name":"beneficiaryType"},{"_id":"58e30b90a1d8c70f00cae1d0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"nameOnAccount"},{"_id":"58dd6fad85a2a02f00051d8b","ref":"","in":"body","required":true,"desc":"Required for Individual","default":"","type":"string","name":"firstNameOnAccount"},{"_id":"58dd6fad85a2a02f00051d8a","ref":"","in":"body","required":true,"desc":"Required for Individual","default":"","type":"string","name":"lastNameOnAccount"},{"_id":"58ddba0375b5b20f00fa65bf","ref":"","in":"body","required":true,"desc":"Required for Business","default":"","type":"string","name":"beneficiaryCompanyName"},{"_id":"58ddba0375b5b20f00fa65be","ref":"","in":"body","required":true,"desc":"Required for Business","default":"","type":"string","name":"beneficiaryEinTin"},{"_id":"58dd66931477020f002d4af1","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"beneficiaryAddress"},{"_id":"58dd66931477020f002d4af0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"beneficiaryAddress2"},{"_id":"58dd66931477020f002d4aef","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"beneficiaryCity"},{"_id":"58dd66931477020f002d4aee","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"beneficiaryPostal"},{"_id":"58dd66931477020f002d4aed","ref":"","in":"body","required":true,"desc":"Required for Individual","default":"","type":"string","name":"beneficiaryPhoneNumber"},{"_id":"58ddba0375b5b20f00fa65bd","ref":"","in":"body","required":true,"desc":"Required for Business","default":"","type":"string","name":"beneficiaryLandlineNumber"},{"_id":"58dd66931477020f002d4aec","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"beneficiaryState"},{"_id":"58dd6fad85a2a02f00051d86","ref":"","in":"body","required":true,"desc":"Required for Business","default":"","type":"string","name":"beneficiaryEmailAddress"},{"_id":"58dd6fad85a2a02f00051d84","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"beneficiaryDobDay"},{"_id":"58dd6fad85a2a02f00051d83","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"beneficiaryDobMonth"},{"_id":"58dd6fad85a2a02f00051d82","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"beneficiaryDobYear"},{"_id":"58dd66931477020f002d4af5","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"accountNumber"},{"_id":"58dd66931477020f002d4af4","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"routingNumber"},{"_id":"58dd66931477020f002d4af6","ref":"","in":"body","required":false,"desc":"`CHECKING` | `SAVINGS`","default":"","type":"string","name":"accountType"},{"_id":"5a1c5d3723a889002a05d45c","ref":"","in":"body","required":true,"desc":"set to True","default":"","type":"boolean","name":"chargeablePM"}],"url":"/paymentMethods"},"isReference":false,"order":10,"body":"","excerpt":"","slug":"deposit","type":"endpoint","title":"Add Bank Account"}

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