Get Subscription
The Get Subscription API enables merchants to retrieve comprehensive information regarding a specific subscription. This functionality is important for businesses to efficiently manage their subscription and provide better support to their customers. The primary purpose of the Get Subscription API is to offer merchants access to detailed subscription data.
To initiate a Get Subscription API call, you will need to provide the required "subscriptionid" field as part of the path parameters:
Parameter | Datatype | Description | Mandatory |
---|---|---|---|
subscriptionid | string | The id generated on the subscription creation | Yes (path parms) |
Usage of the API environment endpoints
Please make sure you use the correct endpoint based on your environment
- KSA Environment: https://api.ksamerchant.geidea.net/
- Egypt Environment: https://api.merchant.geidea.net/
- UAE Environment: https://api.geidea.ae/
Signature creation for Get Subscription request
We have a signature parameter in the GetSubscription API to have an additional layer of security during payment processing. To generate the signature, follow the steps below:
- Concatenate the parameters MerchantPublicKey and SubscriptionID as a string
- Hash the concatenated string with the MerchantPrivateKey(API password) as a key (algorithm for hashing: SHA256)
- Base64 encodes the hash
Signature creation for Get Subscription response
- Concatenate the parameters MerchantPublicKey, Amount, Response Code, and Detail Response Code as a string
- Hash the concatenated string with the MerchantPrivateKey(API password) as a key (algorithm for hashing: SHA256)
- Base64 encodes the hash
Sample Request & Response
curl --request GET \
--url https://api.merchant.geidea.net/subscriptions/api/v1/direct/subscription/8a055aa4-13d9-4f74-421d-08dc3cbb381c \
--header 'accept: application/json' \
--header 'authorization: Basic YTA4N2Y0Y2EtOTg5MC00MDdiLTljMmYtNzYzMDgzNmNjMDIwOjI2ZDMxOTE3LTcxNWUtNDhhYy1iMDcyLWRhOTczODAxNmFmNQ=='
--data-raw '{
"signature":"1KeVT7QumxpsWY8SnWN8WzTBlKdwz1EGBaANIEoh5mg="
}'
#TODO
Updated 4 months ago