Before you start
You need the following before you can deactivate a merchant.- At least one boarded merchant that you want to deactivate.
- For Boarding API deactivation: OAuth authentication configured.
- For Boarding File Upload (XML) deactivation: secure connectivity setup completed, including Secure File Transfer Protocol (SFTP) credentials.
What deactivation does
Deactivation is a soft delete. The merchant record remains in the system but is flagged as inactive. Once deactivated:- The rate service rejects DCC offer requests for the merchant.
- The merchant no longer appears as active in reporting.
- Historical transaction data is preserved.
- The merchant can be reactivated without re-boarding.
Deactivate via Boarding API
The Boarding API supports deactivation through the Create a batch of boarding requests endpoint. Set theoperation field to control what is deactivated.
The full steps to deactivate a merchant via the Boarding API are below.
1
Submit a deactivation request
Send aPOST request to
Create a batch of boarding requests
with the operation set to DEACTIVATE_LOCATION.The following example deactivates a merchant.- Request
- Response
2
Poll for status
Send aGET request to
Get boarding status
to check the deactivation status.- Request
- Response
A successful deactivation returns a
status of COMPLETED
with 0 in the errors field of the batchSummary. If the
deactivation failed, call
Get boarding summary status
to see the error details for each merchant.Deactivate via Boarding File Upload (XML)
The Boarding File UploaddeleteMerchant element deactivates a merchant by
merchant ID. Add one deleteMerchant element per merchant you
want to deactivate.
1
Build the deactivation XML
AdddeleteMerchant elements to your Boarding File Upload XML file. Each
element needs only the merchant id attribute.2
Validate and submit
Validate the file against the Boarding File Upload XSD, then upload it to your Fexco SFTP folder. See Validate an XML file before submission for validation instructions.3
Check the response file
After processing, Fexco places a response file in your SFTP folder. Each deactivated merchant appears as a row with aDEACTIVATE action.Each
DEACTIVATE row has a 200 status code and no errors.
If any merchants failed, correct the data and resubmit only
the failed merchants in a new Boarding File Upload file.Related content
- Reactivate a merchant: restore a deactivated merchant to active DCC participation.
- Update a boarded merchant: change a merchant’s details without deactivating them.
