Partner Endpoints

partner/account

Changed on Nov 3, 2026

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

Request

Base URL
https://earthnode-dev.vopay.com/api/v2
URL
https://earthnode-dev.vopay.com/api/v2/partner/account
Auth
none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Limitinteger

Limit the number of records that are returned.

Offsetinteger

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, contact details, and other KYC fields for each account. Defaults to true.

IncludeChildAccountsboolean

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

IncludeAccountDetailsboolean

When true, includes ApiKey, RollingReserves and LimitUsage for each account. Defaults to false.

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

PartnerAccountIDstring

Account ID of the authenticated partner account

PartnerAccountstring required

Partner account name

RevSharestring nullable required

Partner's revenue share percentage. Null when not applicable (e.g. the partner's agreement type charges a minimum program fee instead). Mutually exclusive with MinimumProgramFee.

MinimumProgramFeestring nullable required

Partner's minimum program fee. Null when not applicable (e.g. the partner's agreement type earns a revenue share instead). Mutually exclusive with RevShare.

CSVFilestring

CSV file contents, returned instead of Accounts when ExportCSV=true.

Example response

{
  "Success": true,
  "PartnerAccountID": "ParentAccount1",
  "PartnerAccount": "ParentAccount1",
  "Accounts": {
    "0": {
      "LegalBusinessName": "Company Legal Business Name",
      "DBAName": "Doing Business As Name",
      "AccountName": "SubaccountName1",
      "ParentAccountName": "ParentAccount1",
      "PartnerAccountName": "ParentAccount1",
      "PartnerAccountID": "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": {
          "DateAdded": "2019-11-03 01:00:00",
          "AccountStatusDate": "2019-11-03 01:00:00",
          "Website": "https://www.mycompany.com",
          "ProductDescription": "Online marketplace for handmade goods",
          "Industry": "Retail",
          "IndustrySubCategory": "E-commerce",
          "SubAccountsEnabled": true,
          "PrimaryContact": {
            "FullName": "Jane Doe",
            "Title": "Controller",
            "Email": "jane.doe@mycompany.com",
            "PhoneNumber": "604556****"
          },
          "BillingContact": {
            "FullName": "Jane Doe",
            "Title": "Controller",
            "Email": "jane.doe@mycompany.com",
            "PhoneNumber": "604556****"
          },
          "TechnicalContact": {
            "FullName": "Jane Doe",
            "Title": "Controller",
            "Email": "jane.doe@mycompany.com",
            "PhoneNumber": "604556****"
          },
          "SupportContact": {
            "FullName": "Jane Doe",
            "Title": "Controller",
            "Email": "jane.doe@mycompany.com",
            "PhoneNumber": "604556****"
          },
          "ApiKey": "abc123",
          "RollingReserves": {
            "0": {
              "ReservePercentage": "10",
              "ReserveType": "nsf",
              "AutoCalculate": true,
              "TransactionType": "EFT"
            }
          },
          "LimitUsage": {
            "Inbound": {
              "Daily": "1000.00",
              "Weekly": "5000.00",
              "Monthly": "20000.00"
            },
            "Outbound": {
              "Daily": "1000.00",
              "Weekly": "5000.00",
              "Monthly": "20000.00"
            }
          },
          "LimitUsageAvailable": true,
          "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"
        }
      },
      "DateAdded": "2019-11-03 01:00:00",
      "AccountStatusDate": "2019-11-03 01:00:00",
      "Website": "https://www.mycompany.com",
      "ProductDescription": "Online marketplace for handmade goods",
      "Industry": "Retail",
      "IndustrySubCategory": "E-commerce",
      "SubAccountsEnabled": true,
      "PrimaryContact": {
        "FullName": "Jane Doe",
        "Title": "Controller",
        "Email": "jane.doe@mycompany.com",
        "PhoneNumber": "604556****"
      },
      "BillingContact": {
        "FullName": "Jane Doe",
        "Title": "Controller",
        "Email": "jane.doe@mycompany.com",
        "PhoneNumber": "604556****"
      },
      "TechnicalContact": {
        "FullName": "Jane Doe",
        "Title": "Controller",
        "Email": "jane.doe@mycompany.com",
        "PhoneNumber": "604556****"
      },
      "SupportContact": {
        "FullName": "Jane Doe",
        "Title": "Controller",
        "Email": "jane.doe@mycompany.com",
        "PhoneNumber": "604556****"
      },
      "ApiKey": "abc123",
      "RollingReserves": {
        "0": {
          "ReservePercentage": "10",
          "ReserveType": "nsf",
          "AutoCalculate": true,
          "TransactionType": "EFT"
        }
      },
      "LimitUsage": {
        "Inbound": {
          "Daily": "1000.00",
          "Weekly": "5000.00",
          "Monthly": "20000.00"
        },
        "Outbound": {
          "Daily": "1000.00",
          "Weekly": "5000.00",
          "Monthly": "20000.00"
        }
      },
      "LimitUsageAvailable": true
    }
  },
  "PaginationMetaData": {
    "TotalRecords": 1000,
    "Offset": 1000,
    "Limit": 1000
  }
}

Changes

Nov 3, 202671f251deb318 Revision changes
- breaking
  removed the required property from the response with the status
- warning
  deleted the query request parameter Limit
- warning
  deleted the query request parameter Offset
- info
  added the new optional query request parameter IncludeAccountDetails
- info
  added the new optional query request parameter Limit
- info
  added the new optional query request parameter Offset
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history