FAfatzebra
Merchants

Cancel a merchant

Transitions the merchant to closed. No body is expected.

post/merchants/{username}/cancel

Request

  • Base URL
    https://gateway.pmnts.io/v2/partners
  • URL
    https://gateway.pmnts.io/v2/partners/merchants/{username}/cancel
  • Auth
    HTTP basic

Response

The closed merchant.

idstring required

The merchant's username (e.g. acme-store).

status'pending' | 'active' | 'suspended' | 'closed' required

The merchant's lifecycle state.

namestring nullable

The merchant's legal/registered business name (e.g. Acme Pty Ltd).

trading_namestring nullable

The name the merchant trades under (e.g. Acme Store).

company_numberstring nullable

The merchant's company/business registration number (e.g. an Australian Business Number, 51824753556).

websitestring nullable

The merchant's website URL (e.g. https://acme.example).

mccstring nullable

Merchant category code — ISO 18245, 4 digits (e.g. 5411).

emailstring email nullable

Contact email address (e.g. ops@acme.example).

phonestring nullable

Contact phone number in E.164 format (e.g. +61730000000).

three_d_secure_enabledboolean

Whether 3-D Secure is enabled for the merchant.

fraud_screening_enabledboolean

Whether fraud screening is enabled for the merchant.

network_tokenisation_enabledboolean

Whether network tokenisation (Visa VTS / Mastercard MDES) is enabled.

walletsstring[]

Digital wallets enabled for the merchant.

statement_descriptorstring nullable

Card-acceptor name shown on the cardholder's statement, max 25 chars (e.g. ACME STORE).

government_controlledboolean

Whether the merchant is a government-controlled entity.

country_of_originstring nullable

ISO-3166 alpha-2 country of origin (e.g. AU).

country_codestring nullable

ISO-3166 numeric country code (e.g. 036 for Australia).

fee_program_indicatorstring nullable

Scheme fee program indicator (e.g. S).

mastercard_iso_idstring nullable

Mastercard ISO/acquirer identifier (e.g. 00001234).

visa_iso_idstring nullable

Visa ISO/acquirer identifier (e.g. 00005678).

mastercard_assigned_idstring nullable

Mastercard Assigned ID (MAID) (e.g. MAID12345).

visa_merchant_verification_valuestring nullable

Visa Merchant Verification Value (MVV) (e.g. MVV98765).

customer_support_phonestring nullable

Customer support phone number shown to cardholders (e.g. +61 7 1234 5678).

card_acceptor_namestring nullable

Card-acceptor name sent to the card schemes (e.g. ACME STORE).

card_acceptor_locationstring nullable

Card-acceptor location/city sent to the card schemes (e.g. BRISBANE).

card_acceptor_countrystring nullable

Card-acceptor country, ISO-3166 alpha-2 (e.g. AU).

timezonestring nullable

IANA timezone identifier the merchant operates in.

merchant_identifierstring nullable

A partner-assigned identifier for the merchant. Distinct from the acquirer-assigned merchant_id (MID) — this is a free-form label the partner uses to track the merchant in their own systems.

created_atstring date-time nullable

When the merchant was created — ISO 8601 UTC (e.g. 2026-05-29T04:21:00Z).

updated_atstring date-time nullable

When the merchant was last updated — ISO 8601 UTC (e.g. 2026-05-29T04:21:00Z).

Example response

{
  "timezone": "Australia/Sydney"
}

Changes

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