v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Partner Endpoints

partner/account

This endpoint is used to get a list of accounts created using a partner account. It will return the accounts data including shareholder, signing authority and balance information

get/partner/account

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Limit integer

Limit the number of records that are returned.

Offset integer

Use this parameter to set the starting point in the dataset.

IncludeBalancesboolean

When true, includes balance data for each account. Defaults to true.

IncludeExtendedInfoboolean

When true, includes signing authorities, beneficial owners, and other KYC fields for each account. Defaults to true.

IncludeChildAccountsboolean

When true, includes nested sub-accounts for each account. Defaults to true.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

PartnerAccountstring required

Partner account name

Example response

{
  "Success": true,
  "PartnerAccount": "ParentAccount1",
  "Accounts": {
    "0": {
      "LegalBusinessName": "Company Legal Business Name",
      "DBAName": "Doing Business As Name",
      "AccountName": "SubaccountName1",
      "ParentAccountName": "ParentAccount1",
      "AccountID": "Subaccount1",
      "Email": "subaccount.mail@email.com",
      "Fax": "604556****",
      "City": "Vancouver",
      "Province": "BC",
      "Country": "Canada",
      "PostalCode": "V2W 4V6",
      "Address": "112 Bentall Street",
      "FlinksUrl": "https://www.mycompany.com/flinks-url",
      "WebhookUrl": "https://www.mycompany.com/webhook-listener",
      "ParentAccounts": {
        "0": {
          "AccountID": "acme_inc",
          "AccountName": "ACME Inc.",
          "ParentAccountID": "acme_llc"
        }
      },
      "SubAccounts": {
        "0": {
          "LegalBusinessName": "Company Legal Business Name",
          "DBAName": "Doing Business As Name",
          "AccountName": "SubaccountName1",
          "ParentAccountName": "ParentAccount1",
          "AccountID": "Subaccount1",
          "Email": "subaccount.mail@email.com",
          "Fax": "604556****",
          "City": "Vancouver",
          "Province": "BC",
          "Country": "Canada",
          "PostalCode": "V2W 4V6",
          "Address": "112 Bentall Street",
          "FlinksUrl": "https://www.mycompany.com/flinks-url",
          "WebhookUrl": "https://www.mycompany.com/webhook-listener",
          "IsActive": true,
          "GCMEnabled": true,
          "EFTCollectEnabled": true,
          "EFTSendEnabled": true,
          "USDEFTCollectEnabled": true,
          "USDEFTSendEnabled": true,
          "RTRWithdrawEnabled": true,
          "VisaDirectEnabled": true,
          "InteracMoneyRequestEnabled": true,
          "InteracBulkPayoutEnabled": true,
          "PayLinkEnabled": true,
          "PortalViewOnly": true,
          "AddUserEnabled": true,
          "TransactionApprovalWorkflowEnabled": true,
          "AutoBalanceTransferEnabled": true,
          "MaxFundEFTAmount": 4500,
          "MaxWithdrawEFTAmount": 4500,
          "MaxGCMAmount": 4500,
          "MaxInteracMoneyAmount": 4500,
          "MaxInteracBulkPayoutAmount": 4500,
          "MaxVisaDirectAmount": 4500,
          "Balances": {
            "0": {
              "Currency": "CAD"
            }
          },
          "ShareHolders": {
            "0": {
              "FullName": "Share holder name",
              "Ownership": "20",
              "HomeAddress": "123 address st, Vancouver",
              "DateAdded": "2019-11-03 01:00:00"
            }
          },
          "SigningAuthorities": {
            "0": {
              "FullName": "Signing Authority name",
              "EmailAddress": "signingauthority@gmail.com",
              "HomeAddress": "123 address st, Vancouver",
              "DateAdded": "2019-11-03 01:00:00"
            }
          }
        }
      },
      "IsActive": true,
      "GCMEnabled": true,
      "EFTCollectEnabled": true,
      "EFTSendEnabled": true,
      "USDEFTCollectEnabled": true,
      "USDEFTSendEnabled": true,
      "RTRWithdrawEnabled": true,
      "VisaDirectEnabled": true,
      "InteracMoneyRequestEnabled": true,
      "InteracBulkPayoutEnabled": true,
      "PayLinkEnabled": true,
      "PortalViewOnly": true,
      "AddUserEnabled": true,
      "TransactionApprovalWorkflowEnabled": true,
      "AutoBalanceTransferEnabled": true,
      "MaxFundEFTAmount": 4500,
      "MaxWithdrawEFTAmount": 4500,
      "MaxGCMAmount": 4500,
      "MaxInteracMoneyAmount": 4500,
      "MaxInteracBulkPayoutAmount": 4500,
      "MaxVisaDirectAmount": 4500,
      "Balances": {
        "0": {
          "Currency": "CAD"
        }
      },
      "ShareHolders": {
        "0": {
          "FullName": "Share holder name",
          "Ownership": "20",
          "HomeAddress": "123 address st, Vancouver",
          "DateAdded": "2019-11-03 01:00:00"
        }
      },
      "SigningAuthorities": {
        "0": {
          "FullName": "Signing Authority name",
          "EmailAddress": "signingauthority@gmail.com",
          "HomeAddress": "123 address st, Vancouver",
          "DateAdded": "2019-11-03 01:00:00"
        }
      }
    }
  },
  "Pagination": {
    "TotalRecords": "1000",
    "Offset": "1000",
    "Limit": "1000"
  }
}

All 403 operations