remittance/create

post

https://earthnode-dev.vopay.com/api/v2/remittance/create

This endpoint is used to create a tax remittance transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

AccountID

string

required

Your account ID

Key

string

required

API key for the account

Signature

string

required

Hashed signature for the request

ClientAccountID

string

Client Account ID

IdempotencyKey

string

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

TaxRemittanceType

string

required

The type of tax remittance to perform. 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.

Amount

number

required

The total amount of the remittance payment.

TaxAccountNumber

string

required

The tax account number for the remittance.

TaxPeriodEndDate

string

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

PayerName

string

required

The legal name of the payer.

ClientReferenceNumber

string

An optional reference number which was associated with the transaction.

Notes

string

An optional note to associate with the transaction.

Details

string

A JSON formatted string specifying additional data that is required for certain remittance types. Please contact your integration specialist for specifics.

GLCode

string

An optional unique identification general ledger code.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200