Terminate a merchant
Terminate or deactivate a merchant, a project or a user, and what each status still allows.
When a merchant stops processing on your platform, you change its status. Nothing is deleted: the merchant, its orders and its transactions stay on your platform for support and reporting. Choose the status by what the merchant may still do.
Choose the status
| You want to | Set | What still works |
|---|---|---|
| End the contract, with an ending period | The end date of the merchant's main contract. Ginger sets ending when it passes | The projects can't start new payments. Ask your Ginger contact what else still works in the ending period |
| Close the merchant for good | ended | Nothing. Users and API keys can't log in, and nobody can change the merchant anymore |
| Remove a merchant you never activated, or reject an application | inactive, or delete the merchant | Users and API keys can't log in |
| Remove one project | inactive, or delete the project | Its API key stops working. The other projects keep working |
| Remove one user | inactive, or delete the user | The user can't log in |
See Merchant statuses for the full lifecycle.
Ended is permanent
A merchant in ended can't be changed anymore, not even by you. ending moves on to ended by itself when the ending
period is over. If you may need the merchant again, ask your Ginger contact whether inactive lets you bring it back.
Change the status
- Open the merchant and go to Details.
- Click Edit, set the Status and click Save changes.
For a project or user, open it under Projects or Users of the merchant and change its status the same way.
Update the merchant with its new status:
curl https://api.example.com/v1/admin/merchants/$MERCHANT_ID/ \
--user "$API_KEY:" \
--header "Content-Type: application/json" \
--request PUT \
--data '{
"company_name": "Acme Coffee B.V.",
"status": "inactive"
}'A DELETE on a merchant, project or user sets its status to inactive: nothing is removed. A merchant in ending
or ended can't be deactivated this way. See
Update a merchant in the API reference.
Before you terminate a merchant
- Settle what's still open: captures of pre-authorisations, refunds the merchant promised, and its last payout. See Payouts and fees.
- End its processor contracts with an end date, and tell the processor if it boarded the merchant on its side. With automatic boarding on Silverflow, ask your Ginger contact whether Ginger closes the merchant and its acceptors there.
- Pause or remove its payout configuration once the last payout is made.