Bank Account

Open Bank Account

If, during the creation of a Veem account, one did not provide a bank account but still wants to add a bank account, they can use the following endpoint.

POST https://sandbox-api.veem.com/veem/v1.2/account/bank-account

Headers

There are 2 headers necessary for the use of this endpoint:

• X-request-id: This is a number unique to the current API request, and follows the UUID format. Reusing this header without changing the value will result in a 500 (Internal Server Error) status. An example X-request-id is as follows:

48855846-628d-4177-b071-80332a116f0a

• Authorization: This header holds the bearer token required to use Veem's public API. Failure to use a valid bearer token will result in a 404 (Not Found) status. An example of a valid token is as follows:

Bearer c047594b-082c-4da1-be89-08fe3770f4b3

Request Payload

When adding bank account information to a Veem account using this endpoint, one should create a request using the following format:

{
    "routingNumber": "026009593",
    "bankName": "Bank of America",
    "bankAccountNumber": "12345678",
    "currencyCode": "USD",
    "isoCountryCode": "US"
}

Request Parameters

The following table contains detailed information on the payload's parameters, such as the parameter name, formatting, and size of the parameter.

Note: All of these parameters are mandatory

Country codes can be found here: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

Response Payload

Once a valid request has been sent, a response payload of this format should be expected:

{
    "id": 2761,
    "accountId": 940651,
    "isoCountryCode": "US",
    "isoCurrencyCode": "USD",
    "bankName": "Bank of America",
    "beneficiaryName": "NGLs",
    "accountType": "Checking",
    "canRemove": true,
    "shortIdentifierDomestic": "5678",
    "verificationStatus": "Unverified",
    "status": "Active",
    "externalAccountStatus": "NotConfigured"
}

Response Errors

When creating an invalid request, one can expect a bad request response to look like the following response:

{
    "timestamp": 1705606629966,
    "status": 400,
    "error": "Bad Request",
    "message": "Missing bank account fields: [routingNumber, bankAccountNumber]",
    "path": "/veem/v1.2/account/bank-account"
}

Edit Bank Account

If one wants to modify bank account details of a Veem account with an existing bank account, they can use the following endpoint:
PATCH https://sandbox-api.veem.com/veem/v1.2/account/bank-account/{bankId}

The headers required for the use of this endpoint are the same ones as the Add Bank Account endpoint, and can be reused for this endpoint

Request Payload

The request payload for editing the bank account of a Veem account is the exact same as the Add Bank Account payload. All the fields are mandatory, and existing information that you do not want to modify will need to be duplicated in the request payload

Response Payload

The response payload for editing the bank account of a Veem account is the exact same as the Add Bank Account payload.