POST Suspend Vendor
The POST Suspend Vendor method allows merchants to temporarily suspend a vendor, preventing any payments from being issued to them. A merchant may suspend payments to a vendor, for example, in scenarios where a vendor's service agreement is pending renewal, compliance documentation is missing, or their remittance account information is invalid.
A vendor must currently be in Approved status before it can be suspended.
Note: This API is supported in AndDone version 2.3 only.
| API Endpoint |
| https://api.uat.anddone.com/secure/merchants/vendors/suspend |
| API Data | Details |
| URI | secure/merchants/vendors/suspend |
| Method | POST |
| Authorization | API Key Authorization |
| Authorization | |
| x-api-key | API key {env_merchantAccessKey} |
| Request Headers | |
| x-app-key | Merchant ID or App Key {env_merchantId} |
| x-version | API version (e.g., 2.3) |
| Origin | URL or IP address provided to AndDone as an allowed origin. |
| Content-Type | application/json |
Request Parameters
| Field Name | Data Type | Mandatory | Field Length | Description |
Body Request Example (JSON)
Response
This method returns code 200 if the specified vendor was successfully suspended.