Merchant lifecycle
Once a merchant exists, you have a handful of lifecycle actions beyond create. See Boarding a merchant for create.
Read and list
# List all your merchants (paginated — see Conventions)
curl https://gateway.pmnts.io/v2/partners/merchants \
-u "$PARTNER_USERNAME:$PARTNER_TOKEN"
# Read one
curl https://gateway.pmnts.io/v2/partners/merchants/acme-coffee \
-u "$PARTNER_USERNAME:$PARTNER_TOKEN"Update
Prefer PATCH for partial updates. PUT is a full replace and rarely needed.
curl -X PATCH https://gateway.pmnts.io/v2/partners/merchants/acme-coffee \
-u "$PARTNER_USERNAME:$PARTNER_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "trading_name": "Acme Coffee Co." }'Activate / suspend / close
| Action | Reversible? | When to use |
|---|---|---|
POST /merchants/{username}/suspend | Yes — call /activate | Risk flag, billing issue, temporary pause |
POST /merchants/{username}/activate | n/a | Bring a suspended merchant back online |
POST /merchants/{username}/close | No — terminal | Merchant leaves the platform |
curl -X POST https://gateway.pmnts.io/v2/partners/merchants/acme-coffee/suspend \
-u "$PARTNER_USERNAME:$PARTNER_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "reason": "billing arrears" }'Close is terminal. There is no API to undo it — contact Fat Zebra support if it was a mistake.
Rotate credentials
If the merchant's gateway token might be compromised:
curl -X POST https://gateway.pmnts.io/v2/partners/merchants/acme-coffee/credentials/rotate \
-u "$PARTNER_USERNAME:$PARTNER_TOKEN"The new token is in the response — shown once, like at create time. See Authentication.