Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Verify a Bank Link
This request verifies a specific microdeposit(MD)bank link on an account. The API user provides the two microdeposit amounts as decimal strings, the operation the unique banklink id, and the user name of the account owner.
If all verification attempts are used, the banklink will be automatically canceled by the system.
Notes
- If all verification attempts are used, the banklink will be automatically canceled by the system.
Error Codes
| Code | Description |
|---|---|
| banklink.null.restbanklink.internal.error | The rest request body failed to properly convert into a banklink object. This error could possibly have been caused by malformed JSON or some sort of internal error. |
| banklink.not.owned.by.account |
Either the banklink or account number passed in the request URI is incorrect and a banklink cannot be found. |
| uri.matching.rule | Occurs when the banklink id provided in the uri doesn't match the banklink passed via the request body JSON |
| banklink.invalid.operation.should.be.delete.verify_md.or.verify_own | The wrong operation was used in the request. |
| banklink.api.user.not.found.internal.error | The API user wasn't found by the system. This is an internal error and REST API support should be consulted. |
| banklink.api.user.needs.money.mover.or.better.permissions.for.account | The API user doesn't have the 'money mover' or better permissions necessary to create banklinks. Please consult REST API support. |
| banklink.no.member.found.for.loginid | The 'ownerLoginId' provided in the request body cannot be found in the system. Please verify that the info is correct. |
| banklink.loginid.provide.not.account.owner | The 'ownerLoginId' provided in the request body is not the account owner. Please verify that the info is correct. |
| banklink.verification.failed.microdeposits.due.to.incorrect.microdeposit.amounts | The microdeposit amounts provided are not correct. |
Request URL
| Syntax | PUT /restapi/accounts/{accountnumber}/verify/microdeposits/{banklinkoid} |
|---|---|
| Example URL | https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/verify/microdeposits/8430738503704092526 |
Request Data Fields
| Field | Updateable? | Description |
|---|---|---|
| banklinkOid | No | The unique identifier for the specific bank link. |
| md1 | No | The decimal amount for micro-deposit one. |
| md2 | No | The decimal amount for micro-deposit two. |
| op | No | The requested verify operation. |
| ownerLoginId | No | The login id of the client for which the banklink is being verified. |
Request Example
PUT /restapi/accounts/RD57828005/verify/microdeposits/7926335346173182966 HTTP/1.1
Content-Type: application/json
{
"md1" : "0.04000",
"md2" : "0.23000",
"op" : "verify_md",
"ownerLoginId" : "testuser"
}
Response Example 1: Successful Verification
If the verification attempt fails, the system will return an error code in the 'errorCode' field of the response body.
The system will also return the 'number of remaining attempts' in the 'message' field of the response body.
HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/verify/microdeposits/8430738503704092526
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
{
"bankLinkOid":"1297036694683812884",
"verifyStatus":true
}
Response Example 2: Incorrect Verification attempt
If the verification attempt fails, the system will return a '400 Bad Request' with information regarding the nature of the error in the response body. The error code is returned in the 'errorCode' field while the 'number of remaining attempts' isr returned in the 'message' field of the response body.
HTTP/1.1 400 Bad Request
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/verify/microdeposits/8430738503704092526
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
[
{
"type": "VALIDATION_RULE",
"errorCode": "banklink.verification.failed.microdeposits.due.to.incorrect.microdeposit.amounts",
"message": "Remaining Attempts=2",
}
]
Response Example 3: Final Verification Failure
After the user has exhausted all verification attempts, the system will cancel the banklink and an error code in the 'errorCode' field. The banklink"s status will also be returned in the 'message' field.
HTTP/1.1 400 Bad Request
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/verify/microdeposits/8430738503704092526
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
[
{
"type": "VALIDATION_RULE",
"errorCode": "banklink.verification.failed.microdeposits.due.to.incorrect.microdeposit.amounts",
"message": "Banklink status=D",
}
]
Change Log
03/12/2020
- Remove the “Description” title
- Remove extra space
09/18/2015
- fixed various bad request links
- fixed errors in request data fields
09/11/2015
- Added Change Log
09/10/2015
- New Docs!