VOvopay
Remittance Endpoints

remittance/create

This endpoint is used to create a tax remittance transaction.

post/remittance/create

Request

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

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ClientAccountIDstring

Client Account ID

IdempotencyKeystring

A unique key which the server can use to recognize and reject subsequent retries of the same request.

RemittanceProfileTokenstring

Token of a saved remittance profile (see POST /remittance/account/profiles/add) to supply TaxRemittanceType, TaxAccountNumber, and PayerName from. When provided, those three parameters must be omitted (sending both is rejected), and the profile's saved DefaultDetails are merged into Details, with any Details supplied on this request taking precedence. An unrecognized, inactive, or client-account-scope-mismatched token is rejected the same way as a nonexistent one.

TaxRemittanceTypestring required

The type of tax remittance to perform. Required unless RemittanceProfileToken is supplied, in which case it must be omitted. Valid options: FED_PAYROLL_THRESHOLD_1, FED_PAYROLL_THRESHOLD_2, FED_PAYROLL_REGULAR_OR_QUARTERLY, FED_CORPORATE_TAX, FED_GST_HST_RETURN, ON_EMPLOYER_HEALTH_TAX, QC_PAYROLL_TWICE_MONTHLY, QC_PAYROLL_WEEKLY, QC_PAYROLL_MONTHLY, QC_GST_HST_QST_COMBINED_RETURN, QC_CORP_INCOME_TAX_REMITTANCE, QC_SUPPORT_PAYMENTS_COLLECTION, QC_PAYROLL_QUARTERLY, ON_FAMILY_RESPONSIBILITY_OFFICE, or WCB_NOVA_SCOTIA_PREMIUM.

Amountnumber required

The total amount of the remittance payment.

TaxAccountNumberstring required

The tax account number for the remittance. Required unless RemittanceProfileToken is supplied, in which case it must be omitted.

TaxPeriodEndDatestring required

The end date of the tax period (YYYY-MM-DD).

PayerNamestring required

The legal name of the payer. Required unless RemittanceProfileToken is supplied, in which case it must be omitted.

ClientReferenceNumberstring

An optional reference number which was associated with the transaction.

Notesstring

An optional note to associate with the transaction.

Detailsstring

A JSON formatted string specifying additional data that is required for certain remittance types. See GET /remittance/tax-categories for the exact RequiredFields per TaxRemittanceType - the set is exact, not a minimum: sending a field not on that list, or omitting one that is, is rejected.

GLCodestring

An optional unique identification general ledger code.

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 transaction that was just performed. This ID should be saved as it is required in order to look up status information on the transaction.

Flaggedstring

Details on why the transaction was flagged, if applicable. Flagged transactions will need to be confirmed by using the /account/transaction/confirm endpoint.

Example response

{
  "Success": true,
  "TransactionID": "1234567",
  "Flagged": "The transaction has been flagged as a potential duplicate."
}

Changes

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