Skip to main content
POST
/
pg
/
subscriptions
/
{subscription_id}
/
modify_mandate
Modify Subscription Mandate
curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/subscriptions/{subscription_id}/modify_mandate/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "amount": "<string>",
  "end_date": "2023-12-25"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "subscription_id": "<string>",
    "mandate_modified": true,
    "updated_amount": "<string>",
    "updated_end_date": "2023-12-25"
  }
}

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.

Body

application/json

Mandate modification payload. At least one of amount or end_date must be provided.

​
amount
string

Amount in decimal format (e.g., "100.00")

​
end_date
string<date>

Response

Subscription mandate modification request sent successfully

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