VOvopay
Remittance Endpoints

remittance/transaction

This endpoint is used to fetch a single tax remittance transaction. To list tax remittance transactions, use the /account/transactions endpoint with TransactionType=Tax Remittance.

get/remittance/transaction

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDstring

The transaction to fetch. Either this or ClientReferenceNumber is required.

ClientReferenceNumberstring

The transaction to fetch. Either this or TransactionID is required. If more than one transaction shares the reference number, the most recent is returned.

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

TransactionIDstring required

The unique ID of the tax remittance transaction.

TransactionStatusstring required

The status of the tax remittance. One of: pending, in progress, successful, cancelled, failed, waiting, pending approval.

TransactionDateTimestring required

The date and time the transaction was created.

LastModifiedstring required

The date and time the tax remittance was last updated.

Amountnumber required

The amount remitted to the tax authority.

Currencystring required

The currency of the remittance. Always CAD.

TaxRemittanceTypestring required

The type of tax remittance that was filed.

TaxAccountNumberstring required

The tax account number the remittance was filed against.

TaxPeriodEndDatestring nullable required

The end date of the tax period being remitted for.

PayerNamestring nullable required

The name of the payer the remittance was filed for.

Detailsobject nullable required

The remittance-type-specific fields that were filed. The keys returned depend on TaxRemittanceType.

ClientReferenceNumberstring required

Your reference number for the transaction.

Notesstring required

Notes recorded against the transaction.

GLCodestring required

The general ledger code recorded against the transaction.

ClientAccountIDstring nullable required

The client account the transaction belongs to. Null if the transaction was not made against a client account.

FailureReasonstring nullable required

The reason the remittance failed, if applicable.

TaxAuthorityErrorCodestring nullable required

The error code returned by the tax authority, if applicable.

Example response

{
  "Success": true,
  "TransactionID": "3141128",
  "TransactionStatus": "pending",
  "TransactionDateTime": "2026-08-10 12:00:00",
  "LastModified": "2026-08-10 12:00:00",
  "Amount": 1000,
  "Currency": "CAD",
  "TaxRemittanceType": "FED_GST_HST_RETURN",
  "TaxAccountNumber": "123456789RT0001",
  "TaxPeriodEndDate": "2026-06-30",
  "PayerName": "Acme Corp",
  "Details": {
    "ReportingPeriodFrom": "2026-04-01",
    "101_SalesAndOtherRevenue": 50000
  },
  "ClientReferenceNumber": "REF-001",
  "ClientAccountID": "abc123",
  "FailureReason": "Invalid tax account number",
  "TaxAuthorityErrorCode": "E01"
}

Changes

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