Remittance Endpoints

remittance/account/profiles

Lists the calling account's saved tax remittance payee profiles. Only active (non-deleted) profiles are returned. Results can be narrowed by client account, remittance type, or a free-text search across Nickname/PayerName/TaxAccountNumber, and are paginated.

get/remittance/account/profiles

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Return only profiles scoped to this client account, plus account-level profiles (usable with any client account). Omit to return profiles across all client accounts (and account-level profiles).

TaxRemittanceTypestring

Return only profiles saved for this remittance category. See GET /remittance/tax-categories for valid options.

SearchTextstring

Free-text search matched against Nickname, PayerName, and TaxAccountNumber (OR across all three, substring match).

Limitinteger

The maximum number of profiles to return. Default is 50. Clamped server-side to between 1 and 100 - a value below 1 is raised to 1, a value above 100 is lowered to 100.

Offsetinteger

The number of profiles to skip. Default is 0. Clamped server-side to a minimum of 0 - a negative value is raised to 0.

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

Example response

{
  "Success": true,
  "RemittanceProfiles": {
    "0": {
      "RemittanceProfileToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
      "TaxRemittanceType": "FED_GST_HST_RETURN",
      "TaxCategoryName": "GST/HST Return",
      "Nickname": "Main GST filing",
      "TaxAccountNumber": "123456789RT0001",
      "PayerName": "Acme Corp",
      "LastModified": "2026-08-21 10:15:00"
    }
  },
  "PaginationMetaData": {
    "TotalRecords": 1,
    "Limit": 50
  }
}

Changes

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