VOvopay
Remittance Endpoints

remittance/account/profiles/add

Saves a reusable tax remittance payee profile (tax category, tax account number, payer name) for the calling account, addressed by an opaque token. Supply the returned RemittanceProfileToken on /remittance/create to reuse the saved identity instead of re-typing it. If a matching TaxAccountNumber/TaxRemittanceType/client-account scope was previously saved and then deleted via /remittance/account/profiles/delete, this reactivates that same profile row rather than creating a new one - the response's RemittanceProfileToken is a brand new token, and the old (deleted) token remains permanently unresolvable.

post/remittance/account/profiles/add

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/remittance/account/profiles/add
  • 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 to scope this profile to. Omit to save an account-level profile usable with any client account (only possible for accounts with client accounts disabled - accounts with client accounts enabled must supply one).

TaxRemittanceTypestring required

The remittance category this profile is saved for. See GET /remittance/tax-categories for valid options.

TaxAccountNumberstring required

The tax account number to save on this profile. Must match the tax account number format required for the selected TaxRemittanceType; federal and Quebec categories include a check digit, which is verified. An off-shape or bad-check-digit value is rejected with INVALID_PARAMETER.

PayerNamestring required

The legal name of the payer to save on this profile.

Nicknamestring

An optional display label for this profile.

DefaultDetailsstring

A JSON formatted string of Details defaults to save on this profile and merge into future /remittance/create calls made with this profile's token. Every key must be a field flagged IsProfileField: true for this TaxRemittanceType in GET /remittance/tax-categories - no field is currently flagged, so any key supplied here is rejected.

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

RemittanceProfileTokenstring required

Opaque 64-character token identifying the saved profile. Supply this on /remittance/create as RemittanceProfileToken to reuse the saved payee identity. Always a newly generated token, even when this call reactivated a previously deleted profile - any token you had stored for that deleted profile is now permanently unresolvable and must be replaced with this one.

Example response

{
  "Success": true,
  "RemittanceProfileToken": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
}

Changes

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