Skip to main content
GET
/
pg
/
subscriptions
/
{subscription_id}
/
mandate_status
Get Subscription Mandate Status
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/subscriptions/{subscription_id}/mandate_status/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "subscription_id": "<string>",
    "mandate_is_active": true
  }
}

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-Merchant-ID
string
header
required

Merchant Identifier - The unique ID for the merchant account. This is required for PSP (Payment Service Provider) merchants who manage multiple merchant accounts. You can find merchant IDs in the Merchant Management section of the dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X' or '2.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

​
uid
string
required

Subscription UID.

Response

Subscription mandate status fetched successfully

​
success
boolean
required
​
message
string
required
​
data
object
required