Collection Account

Overview

Global Collection Accounts enable you to receive bank transfers into and authorize direct debit payouts from the account. Learn how to create, manage and use Global Accounts in the region and currency of choice, as well as retrieve transaction details for the purposes of reconciliation, proof of funds, data analysis using Metaprise API

Before you begin

Sign up the Metaprise developer devhub platform to get your unique Client ID and API key.
Obtain your access token by authenticating to Metaprise using your unique Client ID and API key. You will need the access token to make API calls.
Set up webhooks to receive notifications on Global Collection Account events.

Create a Collection Account

Use dashboard to apply a collection account
1. Sign up and log in the Metaprise dashboard
2. Click Open Account button
3. Select the account type you want to apply and fill the info required

Use API to create a colletcion account

Call the Open a Global Collection Account endpoint with the following parameters:

alternate_account_identifiers*:
- email: Specify an email address for receiving funds via Interac e-Transfer Autodeposit. Refer to Update your Global Account for an example request and supported email format.
  country_code: Specify the region where the Global Account will be held.
nick_name: Specify a name to uniquely identify the Global Account. This is for your own record keeping only, and will not show up on bank statements.
request_id: Specify a unique identifier for the request.
currency: Specify the currency that’s supported for the region provided.
account type: Specify the account type provided.

See Supported regions and currencies to learn more about our supported transfer methods.

Example request

curl --request POST \
--url 'https://api-demo.metaprise.com/api/v1/global_accounts/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_bearer_token>' \
--data '{ 
  "country_code": "US", 
  "nick_name": "USD Account in US for Subsidiary Company ABC", 
  "request_id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",
  "required_features": [{
     "currency": "USD",
     "transfer_method": "LOCAL"
  }, {
     "currency": "USD",
     "transfer_method": "SWIFT"
  }]
}'

Example response

{
  "account_name": "string",
  "account_number": "88888888",
  "account_type": "Checking",
  "country_code": "GP",
  "iban": "GB81LHVB04032900176471",
  "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",
  "institution": {
    "address": "Old Street Yard",
    "branch_name": "Test branch",
    "city": "London",
    "name": "Saxo Payments A/S",
    "zip_code": "018982"
  },
  "nick_name": "GBP in UK for Subsidiary Company ABC",
  "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",
  "required_features": [{
     "currency": "USD",
     "transfer_method": "LOCAL",
     "type": "DEPOSIT"
  }, {
     "currency": "USD",
     "transfer_method": "SWIFT",
     "type": "DEPOSIT"
  }],
  "status": "ACTIVE",
  "supported_features": [{
     "currency": "USD",
     "transfer_method": "LOCAL",
     "local_clearing_system": "ACH",
     "routing_codes": [
        {
          "type": "ach",
          "value": "040329212"
        }
     ],
     "type": "DEPOSIT"
  }, {
     "currency": "USD",
     "transfer_method": "LOCAL",
     "local_clearing_system": "FEDWIRE",
     "routing_codes": [
        {
          "type": "wire",
          "value": "040329218"
        }
     ],
     "type": "DEPOSIT"
  }, {
     "currency": "USD",
     "transfer_method": "LOCAL",
     "local_clearing_system": "ACH",
     "routing_codes": [
        {
          "type": "ach",
          "value": "040329212"
        }
     ],
     "type": "DIRECT_DEBIT"
  }, {
     "currency": "GBP",
     "transfer_method": "LOCAL",
     "local_clearing_system": "RTGS",
     "routing_codes": [
        {
          "type": "bank_code",
          "value": "123"
        }, {
          "type": "branch_code",
          "value": "456"
        }
     ],
     "type": "DEPOSIT"
  }],
  "swift_code": "SXPYDEHH"
}

Retrieve details of your Global Collection Account

Call Get Global Account by ID by specifying Global Account ID in the endpoint URL.

Example request

curl --request GET \
--url 'https://api-demo.metaprise.com/api/v1/global_accounts/<your_global_account_id>' \
--header 'Authorization: Bearer <your_bearer_token>'

Example response

{
  "account_name": "string",
  "account_number": "88888888",
  "account_type": "Checking",
  "country_code": "GP",
  "iban": "GB81LHVB04032900176471",
  "id": "7f687fe6-dcf4-4462-92fa-80335301d9d2",
  "institution": {
    "address": "Old Street Yard",
    "branch_name": "Test branch",
    "city": "London",
    "name": "Saxo Payments A/S",
    "zip_code": "018982"
  },
  "nick_name": "GBP in UK for Subsidiary Company ABC",
  "request_id": "8d411ad4-aed6-1261-92fa-51225212e2e1",
  "required_features": [
    {
      "currency": "GBP",
      "transfer_method": "LOCAL"
    }
  ],
  "status": "ACTIVE",
  "supported_features": [
    {
      "currency": "GBP",
      "local_clearing_system": "ACH",
      "routing_codes": [
        {
          "type": "sort_code",
          "value": "040329"
        }
      ],
      "transfer_method": "LOCAL",
      "type": "DEPOSIT"
    }
  ],
  "swift_code": "SXPYDEHH"
}

You can also retrieve all Global Accounts associated with your Metaprise account using Get a list of Global Accounts .

You may filter the results based on:

Time period: indicating from_created_at and to_created_at
Currency supported by Global Account opening: currency
Status: Processing ,ACTIVE, INACTIVE, CLOSED