VOvopay
Remittance Endpoints

remittance/account/profiles/delete

Soft-deletes a saved tax remittance payee profile. After deletion the profile is invisible to POST /remittance/account/profiles/add (duplicate checks), POST /remittance/account/profiles/edit, and GET /remittance/account/profiles - its token can no longer be used on any of those endpoints or on /remittance/create. Transactions already created from the profile are unaffected and remain fully readable, since they hold their own independent snapshot of the payee details. Saving a new profile via /remittance/account/profiles/add with the same TaxAccountNumber/TaxRemittanceType/client-account scope as a deleted profile reactivates that same profile row under a brand new token; the deleted token is never reused and remains permanently unresolvable.

post/remittance/account/profiles/delete

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/remittance/account/profiles/delete
  • 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

RemittanceProfileTokenstring required

Token of the profile to delete, as returned by POST /remittance/account/profiles/add. An unrecognized, already-inactive, foreign-account, or client-account-scope-mismatched token is rejected as not found.

ClientAccountIDstring

Client Account ID the profile is scoped to. Omit to delete by token alone regardless of the profile's own client-account scope. If supplied, must match the profile's saved client account scope; a client-scoped profile is not found if this does not match, and an account-level profile is found regardless of what is supplied here.

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

Example response

{
  "Success": true
}

Changes

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