3. Merchant Integration Flow: Delete Customer Profile

Delete

Endpoint for when a customer's profile needs to be deleted due to their subscription being cancelled or stopped.

3.3.2.1 Authentication

3.3.2.2 Delete End-Points

Table 21. Delete: Delete API End–Points

Tokenisation Phase : End–Points
PROD ^ https://psp.vodacompaymentgateway.co.za/api/recurring/deleteprofile
UAT ^ https://uat.vodacompaymentgateway.co.za/api/recurring/deleteprofile
QA ^ https://qa.vodacompaymentgateway.co.za/api/recurring/deleteprofile

3.3.2.3 Delete API –POST

Figure 21. Delete API – POST Fields

3.3.2.4 Delete API: POST Field Definitions

Table 22. Delete API: POST Field Definitions
# Field
(Case-Sensitive)		 Required
Mandatory
Optional		 Type Length Description
1. merchantcustomerreference> M String <= 250 A unique value representing the merchant's customer undertaking this tokenisation.
2. merchantid M GUID 36 The GUID id of the merchant provided by the payment gateway.
3. merchanttokenid M GUID 36 The id of the token given to the merchant.
4. merchanttokenreference O String <= 250 A unique identifier provided by the merchant for instances where they wish to cater for multiple customer subscriptions.
A combination of customeridentifier and merchanttokenreference will create a unique token, and allow a single customer to be able to have multiple subscriptions.
If this field is not passed it will be set to merchantcustomerreference above.
5. EncIv O String 16 Random string used by merchant used as the Initialisation Vector to encrypt the message passed in
encXML/encJSON and used by Vodacom to decrypt the message.
Mandatory if encType is TWOFISH or AES.

3.3.2.5 Delete API: Response Codes

Table 23. Delete API Response Codes
# Response Response Code Description
1. OK 200 Profile successfully deleted.
2. Internal Server Error 500 Error deleting profile.
3. Unauthorised 401 Unauthorised access with given merchantid / merchanttokenid.

Continue

Return