How to retrieve a bank account

A bank can be retrieved from the system by using the following URL and POST parameters

 

 Method URL
 POST  https://api.fairwarningsoftware.com/v1.1.1/user/billing/bank/retrieve

 Parameters to pass during the request:

Request
{
    "user_id": <user_id>,
    "bank_id": <bank_idy>
}

 

 Field  Type  Required  Description
user_id int YES The user's unique identification number from the FWS management software.
bank_id string YES The ID of the bank account.

 

 Status Response
 200

 {
    "bank" : {
        "bank_id" : <bank_id>,
        "account_holder_name" : <account_holder_name>,
        "bank_name" : <bank_name>,
        "account_type" : <account_type>,
        "routing_number" : <routing_number>,
        "country" : <country>,
        "last_4" : <last_4>
    }
}
401  {"error":"The API keys provided are invalid."}
403  {"error":"API keys are missing."}
500  {"error": <custom error>}

 

 Field  Type  Description
bank_id string The ID of the credit card.
account_holder_name string The name displayed on the credit card.
bank_name string The name of the bank.
account_type string The type of bank account: "individual" or "company".
routing_number string The routing number for the bank.
country string The country the bank is in.
last_4 int The last 4 digits of the bank account number.
error string Contains the error returned by the API, or false if there were no errors.