Fund Management

Add Bank CAD

The add bank API allows for CAD banking information to be sent in via API. However, for the bank to be verified, you must still send in a wire for any amount from the bank account.

Roles

This API requires the FundManager role. See Roles for more information.

The OAuth scope must have banks:create assigned to access this endpoint. See OAuth Scopes for more information.

post/v1/payments/addbank/cad

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/payments/addbank/cad
  • Auth
    API key in header X-GEMINI-APIKEY and API key in header X-GEMINI-SIGNATURE and API key in header X-GEMINI-PAYLOAD

Headers

X-GEMINI-APIKEYstring required

Your API key

X-GEMINI-SIGNATUREstring required

HEX-encoded HMAC-SHA384 of payload signed with API secret

X-GEMINI-PAYLOADstring required

Base64-encoded JSON payload

Content-Typestring
Content-Lengthstring
Cache-Controlstring

Request body

requeststring required

The literal string "/v1/payments/addbank/cad"

swiftcodestring required

The account SWIFT code

accountNumberstring required

Account number of bank account to be added

institutionNumberstring

The institution number of the account - optional but recommended.

branchnnumberstring

The branch number - optional but recommended.

type'checking' | 'savings' required

Type of bank account to be added. Accepts checking or savings

namestring required

The name of the bank account as shown on your account statements

accountstring

Required for Master API keys as described in Private API Invocation. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.

Example request

{
  "nonce": "1495127793000"
}

Response

Successful operation

resultstring

Status of the request. "OK" indicates the account has been created successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.