1. Tax Payments
  2. Schedule a tax payment
POST
/v1/taxpayers/{taxpayerId}/tax-payments
curl --request POST \
     --url https://public-api.sandbox.remitian.com/v1/taxpayers/{taxpayerId}/tax-payments \
     --header 'Authorization: Bearer <token>' \
     --header 'x-api-key: <x_api_key>' \
     --header 'Content-Type: application/json' \
     --data '{
  "externalId": "string",
  "taxAccountId": "string",
  "taxAuthority": "string",
  "bankAccountId": "<uuid>",
  "paymentTypeId": 1,
  "paymentDate": "<date>",
  "amount": 0,
  "periodEndDate": "<date>",
  "fundingPace": "RegularDirectDebit",
  "remittanceInformation": {
    "type": "CraCorporate",
    "taxCode": "string"
  }
}'

​
Authorizations

bearerAuth
required
string
Access token from POST /v1/auth/token, sent as `Authorization: Bearer {accessToken}`.

​
Query Parameters

taxpayerId
required
string

Unique identifier of the taxpayer.

x-api-key
required
string

API key of your Client Application.

​
Body

application/json
externalId
string

The external identifier provided by the client.

taxAccountId
required
string

The unique identifier of the tax account.

taxAuthority
required
string

Deprecated. The value is ignored: the tax authority always comes from the tax account. The field stays required for backward compatibility.

bankAccountId
string

Optional bank account identifier used to fund the payment.

paymentTypeId
required
integer

The identifier of the payment type.

paymentDate
required
string

The date of the payment (YYYY-MM-DD format).

amount
required
number

The payment amount.

periodEndDate
required
string

End date of the tax period the payment is attributed to (YYYY-MM-DD format).

fundingPace
string

Optional funding pace, defaulting to RegularDirectDebit. Use GET /v1/taxpayers/{taxpayerId}/tax-payments/funding-paces to list the funding paces available for the payment date and amount.

remittanceInformation

Optional remittance details, discriminated by 'type'. Required per payment type family: CraCorporate for CRA corporation income tax, CraPayroll for CRA payroll source deductions, and the matching Quebec type for CA_QC payment types. CRA GST/HST, individual and trust payment types accept no remittance information.

​
Response

application/json
  • 201

  • 400

  • 401

  • 403

  • 404

  • 409

Created

id
string

The unique identifier of the resource.

externalId
string

The external identifier provided by the client.