Was this helpful?

Introduction

Adding your bank accounts enables monetization to add details about your bank accounts to any billing documents or invoices that it produces on your behalf. Developers who purchase postpaid plans can then submit payment to you through the applicable bank accounts.

You only need to add your bank accounts if you plan to support postpaid developers, and you want monetization to generate billing documents.

Toolbox

You can add bank accounts for your organization using the management UI or monetization API. Additionally, you can use the API to add bank accounts for specific developers.

If you use the UI, you add bank accounts by clicking + Add Bank Account on the Bank Accounts page.

If you use the API, you add bank accounts for your organization by issuing a POST request to the /organizations/{org_name}/bank-details resource. You add bank accounts for specific developers by issuing a POST request to the /organizations/{org_name}/developers/{developer}/developer_id/bank-details resource.

After you add bank accounts, you can perform management operations on them such as update or delete. Management operations on a bank account are performed by issuing calls to the /organizations/{org_name}/bank-details/{bank_account_id}} resource.

Adding bank accounts using the UI

You need to set up multiple bank accounts if you have multiple currency rate plans (one for each currency). This enables the appropriate bank account for the currency to be displayed on each invoice.

  1. On the Admin tab, select Bank Accounts.

    This opens the Bank Accounts page.

  2. Click + Add Bank Account on the Bank Accounts page. This opens a Bank Account window.

    Enter the following information in the Bank Account window:

    Field Description
    Bank & Location
    Bank name

    The name of the bank at which your account is held.

    Address

    The street address of the bank at which your account is held (you may enter multiple lines if needed).

    City

    The city in which the bank is located.

    State/Region

    The state or region in which the bank is located.

    ZIP/Post Code

    The ZIP code or postal code of the bank’s location.

    Country

    The country in which the bank is located.

    Account Details
    Account Name

    The name in which the account is held.

    Account Number

    The number of the bank account

    Currency

    The number of the bank account

    Sort Code

    The sort code of the bank at which your account is held (if applicable.)

    Routing code

    The routing code of the bank at which your account is held (if applicable).

    BIC (Swift Code)

    The BIC (Business Identifier Code) also known as a SWIFT (Society for Worldwide Interbank Financial Telecommunication) code of the bank at which your account is held (if applicable).

    IBAN

    The IBAN (International Bank Account Number) for your account (if applicable).

  3. Click Save to save the bank account information (or Discard to cancel). This closes the Bank Account window and returns you to the Bank Accounts page.

     

    The bank account is added to the Bank Accounts page.

  4. Click + Add Bank Account to add another bank account, as needed. Repeat steps 2 and 3 for each bank account that you add.

Updating a bank account using the UI

  1. In the list of bank accounts, navigate to the bank account that you want to update.
  2. Select the account name. This opens the Bank Account window.
  3. Click Edit. Make changes to the account information, as needed.
  4. Click Save to save your updates (or Revert to cancel) and return to the Bank Accounts page.

Deleting a bank account using the UI

  1. In the list of bank accounts, navigate to the bank account that you want to remove.
  2. Click Delete.

Adding a bank account using the API

To add a bank account for an organization, issue a POST request to /organizations/{org_name}/bank-details. To add a bank account for a developer, issue a POST request to /organizations/{org_name}/developers/{developer_id}/bank-details. When you add the bank account, you can supply input such as the bank address, the main currency used in the account, and the account number (all of the input properties are optional). See Bank account configuration settings for a complete list of configuration options.

For example, the following adds a bank account for an organization:

$ curl -H "Content-Type: application/json" -X POST -d \
' {
  "aban": "cd87f3d59cada6af9434abca06333f58",
  "accountName": "Testbank account",
  "accountNumber": "2b66904cdb5219714af1666e3e6b1572",
  "address": {
    "address1": "15 Test EUR street",
    "city": "bank town ",
    "country": "US",
    "id": "eur-address-second",
    "isPrimary": true,
    "state": "CA",
    "zip": "12345"
  },
  "bic": "844e172126540532d1157f38ac657194",
  "currency": "EUR",
  "ibanNumber": "b72e0e0f4490db8b06cec2514011edca",
  "name": "Test Bank",
  "sortCode": "3ba7bc880377a8216a85bf455a0154ac"
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/bank-details -d \  
-u myname:mypass

The following adds a bank account for a developer:

$ curl -H "Content-Type: application/json" -X POST -d \
' {
  "aban": "cd87f3d59cada6af9434abca06333f58",
  "accountName": "Testbank account",
  "accountNumber": "2b66904cdb5219714af1666e3e6b1572",
  "address": {
    "address1": "15 Test EUR street",
    "city": "bank town ",
    "country": "US",
    "id": "eur-address-second",
    "isPrimary": true,
    "state": "CA",
    "zip": "12345"
  },
  "bic": "844e172126540532d1157f38ac657194",
  "currency": "EUR",
  "ibanNumber": "b72e0e0f4490db8b06cec2514011edca",
  "name": "Test Bank",
  "sortCode": "3ba7bc880377a8216a85bf455a0154ac"
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/GrHvREAFe7JLcWbV/bank-details -d \  
-u myname:mypass

The response should look like this:

{
  "aban" : "cd87f3d59cada6af9434abca06333f58",
  "accountName" : "Test Bank Account",
  "accountNumber" : "2b66904cdb5219714af1666e3e6b1572",
  "address" : {
    "address1" : "15 Testbank street",
    "city" : "Bank town",
    "country" : "US",
    "id" : "eur-address-second",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "12345"
  },
  "bic" : "844e172126540532d1157f38ac657194",
  "currency" : "USD",
  "ibanNumber" : "b72e0e0f4490db8b06cec2514011edca",
  "id" : "bfe9ff7d-11f6-4b14-9b77-0ef3087c49bc",
  "name" : " Test Bank",
  "sortCode" : "3ba7bc880377a8216a85bf455a0154ac"
}

If you create rate plans that have multiple currencies, you need to add a bank account for each currency in which you plan to issue an invoice.

Retrieving bank accounts using the API

You can retrieve an individual bank account or all the bank accounts in an organization or for a developer. To retrieve an individual bank account in an organization, issue a GET request to /organizations/{org_name}/bank-details/{bank_account_id}, where {bank_account_id} is the identification of the bank account (the ID is returned in the response when you create the bank account). For example:

$ curl -X GET -H "Accept: application/json"  \
"https://api.enterprise.apigee.com /v1/commerce/organizations/{org_name}/bank-details/bfe9ff7d-11f6-4b14-9b77-0ef3087c49bc" \
-u myname:mypass

To retrieve all the bank accounts in an organization, issue a GET request to /organizations/{org_name}/bank-details/. For example:

$ curl -X GET -H "Accept: application/json"  \
"https://api.enterprise.apigee.com /v1/commerce/organizations/{org_name}/bank-details" \
-u myname:mypass

To retrieve the bank accounts for a developer, issue a GET request to /organizations/{org_name}/developers/{developer_id}/bank-details.

$ curl -X GET -H "Accept: application/json"  \
"https://api.enterprise.apigee.com /v1/commerce/organizations/{org_name}/developers/bfe9ff7d-11f6-4b14-9b77-0ef3087c49bc" \
-u myname:mypass

The response should look something like this:

{
  "bankDetail" : [ {
    "aban" : "132847729290c5f6a06401acff1f212e",
    "accountName" : "BankAccount1",
    "accountNumber" : "0b9e6d0902d38e5336fbddcf89d13348",
    "address" : {
      "address1" : "12345 Main Street",
      "city" : "Bank town ",
      "country" : "US",
      "id" : "bank-address",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "12345"
    },
    "bic" : "9ce41225a9dac606eb0fb147ab4d8fd8",
    "currency" : "USD",
    "ibanNumber" : "e0770c4d5f65498dd10aa543338386c0",
    "id" : "bank-detail",
    "name" : "BankA",
    "sortCode" : "c482c46616c5688fa5ab121137836abd"
  }, { 
    "aban" : "cd87f3d59cada6af9434abca06333f58",
    "accountName" : "Test Bank Account",
    "accountNumber" : "2b66904cdb5219714af1666e3e6b1572",
    "address" : {
      "address1" : "15 Testbank street",
      "city" : "Bank town",
      "country" : "US",
      "id" : "eur-address-second",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "12345"
    },
    "bic" : "844e172126540532d1157f38ac657194",
    "currency" : "USD",
    "ibanNumber" : "b72e0e0f4490db8b06cec2514011edca",
    "id" : "bfe9ff7d-11f6-4b14-9b77-0ef3087c49bc",
    "name" : "Test Bank Account",
    "sortCode" : "3ba7bc880377a8216a85bf455a0154ac"
  } ],
  "totalRecords" : 2
}

Updating a bank account using the API

You can update a bank account by issuing a PUT request to /organizations/{org_name}/bank-details/{bank_account_id}. When you make the update, you need to specify in the request body the updated properties as well as the identification of the bank account. For example, the following API call updates the account name of a bank (the updated property is highlighted in the example):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id": "6fb14d36-c971-4cb4-957c-a4cb3e097519",
  "accountName": "Bank account B" 
}' \
"https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/bank-details/6fb14d36-c971-4cb4-957c-a4cb3e097519" \
-u myname:mypass

The response should look like this (the updated data is highlighted):

{
  "aban" : "cd87f3d59cada6af9434abca06333f58",
   "accountName" : "Bank Account B",
  "accountNumber" : "2b66904cdb5219714af1666e3e6b1572",
  "address" : {
    "address1" : "15 Testbank street",
    "city" : "Bank town",
    "country" : "US",
    "id" : "eur-address-second",
    "isPrimary" : true,
    "state" : "CA",
    "zip" : "12345"
  },
  "bic" : "844e172126540532d1157f38ac657194",
  "currency" : "USD",
  "ibanNumber" : "b72e0e0f4490db8b06cec2514011edca",
  "id" : "bfe9ff7d-11f6-4b14-9b77-0ef3087c49bc",
  "name" : "Test Bank Account",
  "sortCode" : "3ba7bc880377a8216a85bf455a0154ac"
}

Deleting a bank account using the API

To delete a bank account, issue a DELETE request to /organizations/{org_name}/bank-details/{bank_account_id}, where {bank_account_id} is the identification of the bank account to be deleted. For example:

$ curl -X DELETE -H "Accept: application/json"  \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/bank-details/6fb14d36-c971-4cb4-957c-a4cb3e097519" \
-u myname:mypass

Bank account configuration settings

The following bank account configuration options are exposed to the API:

Name Description Default Required?
name

The name of the bank in which the account is held.

N/A No
address

The street address of the bank at which the account is held. The address can include a street address, city, state, Zip code, and country. It can also include an indication whether this is the primary address.

N/A No
accountName

The name in which the account is held.

N/A No
accountNumber

The number of the bank account.

N/A No
currency

The main currency of the bank account. If you have multiple currency rate plans, but only one bank account, you need to set up the bank account multiple times (one for each currency). This enables the appropriate bank account for the currency to be displayed on each invoice.

N/A No
sortCode

The sort code of the bank at which the account is held (if applicable).

N/A No
aban

The American Bankers Association number assigned to the bank that holds the account (if applicable).

N/A No
bic

The BIC (Business Identifier Code) also known as a SWIFT (Society for Worldwide Interbank Financial Telecommunication) code of the bank at which the account is held (if applicable).

N/A No
ibanNumber

The IBAN (International Bank Account Number) for the account (if applicable).

N/A No

Get help

For help, see Apigee Customer Support.

Next steps

Start monetizing your API products. Learn how in Monetize API products.

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.