VantagePay Documentation

Merchants ​

Create a new merchant. ​

POST /v1/merchant/admin

Sample

json
POST /v1/merchant/admin/ZGA
{
  "name": "{{$randomCompanyName}}",
  "category": 5993,
  "emailAddress": "{{$randomEmail}}",
  "mobileNumber": "{{$randomPhoneNumber}}",
  "currency": "GHS",
  "loginCredentials": {
    "username": "{{$randomUserName}}",
    "password": "{{$randomPassword}}@#$123abCD"
  },
  "addresses": [
    {
      "addressType": "POST",
      "addressLine1": "Test 1",
      "addressLine2": "Test 2",
      "postalCode": "23021",
      "countryIsoCode": "GHA",
      "state": "Accra",
      "city": "Accra",
      "location": {
          "longitude": -0.08176,
          "latitude": 5.64311
        }
    }
  ],
  "bankAccount": {
    "accountNumber": "1303032553418",
    "bank": "FBL",
    "currency": "GHS"
  },
  "attributes": [
    {
      "id": 8,
      "value": "P0047415185"
    }
  ]

}

Auth: API key (VantagePayAdminClient).

Request body

FieldTypeRequiredDescription
createdDatestringNoThe UTC date and time at which this merchant record was created.
loginCredentialsobjectNoLogin credentials for a user account - used to authenticate and generate access tokens.
tradingNamestring?NoThe merchant's trading name if different from their registered business name.
franchiseNamestring?NoThe name of the franchise group this merchant belongs to, if applicable.
capturedBystring?NoThe identifier of the user or system that captured this merchant record.
capturedFromstring?NoThe source system or channel through which this merchant was captured.
industryNone, Retail, Restaurant, Forecourt, WorkshopNoThe industry classification of this merchant's business.
phoneNumberstring?NoThe merchant's landline or switchboard phone number.
notificationEmailAddressstring?NoThe email address to which payment notifications are sent.
notificationMobileNumberstring?NoThe mobile number to which payment notification SMSes are sent.
citystring?NoThe city in which the merchant primarily operates.
statestring?NoThe state or province in which the merchant primarily operates.
languageIsoCodeone of 238 values (e.g. None, AAR, AFR, ...)NoThe merchant's preferred language for communications.
webSiteUrlstring?NoThe merchant's website URL.
isRegistrationCompletebooleanNotrue if the merchant has completed their self-registration flow.
isEmailVerifiedbooleanNotrue if the merchant has verified their email address.
isMobileNumberVerifiedbooleanNotrue if the merchant has verified their mobile number via OTP.
vCardstring?NoA vCard-encoded contact string for this merchant, generated by the system.
logoImagestring?NoA base64-encoded logo image for the merchant, used in hosted payment pages and receipts.
taxNumberstring?NoThe merchant's tax registration number (e.g. VAT number).
companyRegistrationNumberstring?NoThe merchant's company registration number as issued by the registrar.
companyRegistrationDatestring?NoThe date on which the merchant's company was formally registered.
adminPasscodestring?NoAn optional admin passcode for POS terminal access control.
logoUrlstring?NoThe publicly accessible URL of the merchant's logo image.
hostedPaymentUrlstring?NoThe URL for this merchant's hosted payment page (VantagePay-generated).
hostedPaymentOptionsobjectNoConfiguration options for a merchant's hosted (online / card-not-present) payment page, including accepted card schemes and settlement timing.
posOptionsobjectNoFeature flags that control which transaction types and capabilities are enabled on a merchant's POS terminals.
businessobjectNoThe legal business entity associated with a merchant, used for KYB verification and settlement.
addressesarray<object>?NoPhysical addresses linked to this merchant.
employeesarray<object>?NoEmployees associated with this merchant.
terminalsarray<object>?NoPOS terminals configured for this merchant.
filesarray<object>?NoFiles uploaded for this merchant (e.g. KYB documents, business registration certificates).
notificationSettingsarray<object>?NoConfigured notification event preferences for this merchant.
attributesarray<object>?NoCustom attribute values associated with this merchant (partner-specific metadata).
bankAccountsarray<object>?NoBank accounts linked to this merchant for settlement.
mobileWalletsarray<object>?NoMobile money wallet accounts linked to this merchant for settlement.
operatingTimesarray<object>?NoThe operating hours configured for this merchant.
devicesarray<object>?NoMobile and POS devices registered to this merchant for push notification delivery.
qrCodesarray<object>?NoEMV QR codes configured for this merchant.
assignedProductReferencesarray<string>?NoThe set of product references (from other merchants) that this merchant has been granted access to in addition to their own products. Sync semantics on admin merchant update: null = caller did not supply the field (no change is applied); empty collection = all existing assignments are cleared; populated collection = assignments are replaced with exactly the supplied set. The self-service merchant update controller strips this field before persistence so only admins can modify merchant product assignments.
referencestring?NoThe system-assigned unique reference (UUID) for this merchant. Assigned on creation; null on new records before persistence.
userReferencestring?NoThe unique reference (UUID) of the authentication user account associated with this merchant profile, if one exists.
yourReferencestring?NoAn optional external reference from the caller's system that identifies this merchant in their own data store.
sourcestring?NoThe identifier of the originating system or partner that registered this merchant.
namestringYesThe trading name of the merchant.
categoryCodeone of 967 values (e.g. 0, 11, 701, ...)YesThe ISO 18245 Merchant Category Code (MCC) that classifies the merchant's type of business.
categorystring?NoThe display name of the merchant category, derived from ZGA.Core.Models.Merchants.BasicMerchant.CategoryCode.
emailAddressstring?NoThe primary contact email address for the merchant.
mobileNumberstring?NoThe primary contact mobile number for the merchant in international MSISDN format.
countryIsoCodeone of 248 values (e.g. None, AFG, ALB, ...)NoThe ISO 3166-1 alpha-3 country code of the country in which the merchant operates.
currencyone of 106 values (e.g. None, AFN, ALL, ...)YesThe ISO 4217 currency in which the merchant transacts.
kybStatusSummaryUnverified, Verified, PartiallyVerified, RejectedNoA summary of the merchant's Know Your Business (KYB) verification status.
shortCodeinteger?NoA short numeric code assigned to the merchant that can be used as a compact identifier in USSD/QR flows.
isActivebooleanNotrue if the merchant account is currently active and able to accept payments.
json
{
  "createdDate": "string",
  "loginCredentials": {
    "username": "string",
    "password": "string",
    "isLockedOut": true,
    "reasonForLockout": "string"
  },
  "tradingName": "string",
  "franchiseName": "string",
  "capturedBy": "string",
  "capturedFrom": "string",
  "industry": "None",
  "phoneNumber": "string",
  "notificationEmailAddress": "string",
  "notificationMobileNumber": "string",
  "city": "string",
  "state": "string",
  "languageIsoCode": "None",
  "webSiteUrl": "string",
  "isRegistrationComplete": true,
  "isEmailVerified": true,
  "isMobileNumberVerified": true,
  "vCard": "string",
  "logoImage": "string",
  "taxNumber": "string",
  "companyRegistrationNumber": "string",
  "companyRegistrationDate": "string",
  "adminPasscode": "string",
  "logoUrl": "string",
  "hostedPaymentUrl": "string",
  "hostedPaymentOptions": {
    "cardNotPresentMID": 0,
    "isVisaEnabled": true,
    "isMastercardEnabled": true,
    "isAmericanExpressEnabled": true,
    "isDinersEnabled": true,
    "settlementTime": "None"
  },
  "posOptions": {
    "isRefundsEnabled": true,
    "isCancellationsEnabled": true,
    "isPurchaseWithCashbackEnabled": true,
    "isWithdrawalsEnabled": true,
    "isBalanceCheckEnabled": true,
    "isCurrencyConversionEnabled": true,
    "isRcsPaymentEnabled": true,
    "isDebiCheckEnabled": true,
    "isPreAuthorizationEnabled": true,
    "isManualCardEntryEnabled": true,
    "isInvoiceNumberEnabled": true,
    "isPasscodeAlwaysRequired": true,
    "fuelPurchaseMethod": "ByAmount"
  },
  "business": {
    "reference": "00000000-0000-0000-0000-000000000000",
    "parentBusinessReference": "00000000-0000-0000-0000-000000000000",
    "createdDate": "string",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "phoneNumber": "string",
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "isActive": true
  },
  "addresses": [
    {}
  ],
  "employees": [
    {}
  ],
  "terminals": [
    {}
  ],
  "files": [
    {}
  ],
  "notificationSettings": [
    {}
  ],
  "attributes": [
    {}
  ],
  "bankAccounts": [
    {}
  ],
  "mobileWallets": [
    {}
  ],
  "operatingTimes": [
    {}
  ],
  "devices": [
    {}
  ],
  "qrCodes": [
    {}
  ],
  "assignedProductReferences": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "reference": "00000000-0000-0000-0000-000000000000",
  "userReference": "00000000-0000-0000-0000-000000000000",
  "yourReference": "string",
  "source": "string",
  "name": "string",
  "categoryCode": 0,
  "category": "string",
  "emailAddress": "string",
  "mobileNumber": "string",
  "countryIsoCode": "None",
  "currency": "None",
  "kybStatusSummary": "Unverified",
  "shortCode": 0,
  "isActive": true
}

Responses

StatusDescription
200The request was successful and the merchant was created.
400The request failed validation, the error object will contain further information.
401The authorization information provided is not valid, authentication is required to access this resource.
403The authorization header does not contain the correct type or you do not have access to this resource.
422The request payload is invalid, the error object will contain further information.
429Too many requests are being sent concurrently or rate limiting has taken effect.
500An unexpected error occurred, the error object will contain further information.

Response body

FieldTypeRequiredDescription
successbooleanNoGets a value indicating whether the operation was successful.
resultobjectNoFull merchant profile, extending ZGA.Core.Models.Merchants.BasicMerchant with trading details, linked accounts, terminals, employees, addresses, and KYB documentation.
json
{
  "success": true,
  "result": {
    "createdDate": "string",
    "loginCredentials": {},
    "tradingName": "string",
    "franchiseName": "string",
    "capturedBy": "string",
    "capturedFrom": "string",
    "industry": "None",
    "phoneNumber": "string",
    "notificationEmailAddress": "string",
    "notificationMobileNumber": "string",
    "city": "string",
    "state": "string",
    "languageIsoCode": "None",
    "webSiteUrl": "string",
    "isRegistrationComplete": true,
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "vCard": "string",
    "logoImage": "string",
    "taxNumber": "string",
    "companyRegistrationNumber": "string",
    "companyRegistrationDate": "string",
    "adminPasscode": "string",
    "logoUrl": "string",
    "hostedPaymentUrl": "string",
    "hostedPaymentOptions": {},
    "posOptions": {},
    "business": {},
    "addresses": [],
    "employees": [],
    "terminals": [],
    "files": [],
    "notificationSettings": [],
    "attributes": [],
    "bankAccounts": [],
    "mobileWallets": [],
    "operatingTimes": [],
    "devices": [],
    "qrCodes": [],
    "assignedProductReferences": [],
    "reference": "00000000-0000-0000-0000-000000000000",
    "userReference": "00000000-0000-0000-0000-000000000000",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "categoryCode": 0,
    "category": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "countryIsoCode": "None",
    "currency": "None",
    "kybStatusSummary": "Unverified",
    "shortCode": 0,
    "isActive": true
  }
}

Code samples ​

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

csharp
using VantagePay.Models.Merchants;

var merchant = await adminClient.Merchants.CreateMerchantAsync(new Merchant { Name = "Acme Stores", City = "Accra" });

Update a merchant's information. ​

PUT /v1/merchant/admin

Sample

json
PUT /v1/merchant/admin
{
"yourReference": "123456",
"reference": "8a8b9824-ac42-42e5-b955-a7a84425988c",
"category": "5399",
"categoryCode": 5399,
"currency": "GHS",
"emailAddress": "demo@vantagepay.com",
"languageIsoCode": "ENG",
"loginCredentials": null,
"mobileNumber": "233111222333",
"name": "Global Enterprises",
"addresses": [
  {
    "addressLine1": "DEFAULT",
    "addressLine2": "",
    "addressLine3": "",
    "addressType": 1,
    "city": "Accra",
    "countryIsoCode": "GHA",
    "postalCode": "0000",
    "reference": "caba6360-1043-41c7-89ad-7402ffebc392",
    "state": "Gt Accra",
    "yourReference": "ADDRESS_1234",
    "location": {
      "latitude": 0.0,
      "longitude": 0.0,
      "timeZone": "UTC"
    }
  }
],
"attributes": [
  {
    "Id": 8,
    "Name": null,
    "Value": "0241931361"
  }
],
"bankAccount": {
  "accountNumber": "1050325859314",
  "bank": "FBL",
  "currency": "GHS"
},
"employees": [],
"notificationSettings": [],
"operatingTimes": [],
"settlementBankAccount": {
  "accountName": null,
  "accountNumber": "1555555777777",
  "bank": "FBL",
  "currency": "GHS"
},
"terminals": [
  {
    "name": "Terminal 1",
    "qrCodes": null,
    "reference": "dc1ea64e-0b38-4f3d-a15e-179df92b014c",
    "yourReference": "2097",
  }
],
"webSiteUrl": ""

}

Auth: API key (VantagePayAdminClient).

Request body

FieldTypeRequiredDescription
createdDatestringNoThe UTC date and time at which this merchant record was created.
loginCredentialsobjectNoLogin credentials for a user account - used to authenticate and generate access tokens.
tradingNamestring?NoThe merchant's trading name if different from their registered business name.
franchiseNamestring?NoThe name of the franchise group this merchant belongs to, if applicable.
capturedBystring?NoThe identifier of the user or system that captured this merchant record.
capturedFromstring?NoThe source system or channel through which this merchant was captured.
industryNone, Retail, Restaurant, Forecourt, WorkshopNoThe industry classification of this merchant's business.
phoneNumberstring?NoThe merchant's landline or switchboard phone number.
notificationEmailAddressstring?NoThe email address to which payment notifications are sent.
notificationMobileNumberstring?NoThe mobile number to which payment notification SMSes are sent.
citystring?NoThe city in which the merchant primarily operates.
statestring?NoThe state or province in which the merchant primarily operates.
languageIsoCodeone of 238 values (e.g. None, AAR, AFR, ...)NoThe merchant's preferred language for communications.
webSiteUrlstring?NoThe merchant's website URL.
isRegistrationCompletebooleanNotrue if the merchant has completed their self-registration flow.
isEmailVerifiedbooleanNotrue if the merchant has verified their email address.
isMobileNumberVerifiedbooleanNotrue if the merchant has verified their mobile number via OTP.
vCardstring?NoA vCard-encoded contact string for this merchant, generated by the system.
logoImagestring?NoA base64-encoded logo image for the merchant, used in hosted payment pages and receipts.
taxNumberstring?NoThe merchant's tax registration number (e.g. VAT number).
companyRegistrationNumberstring?NoThe merchant's company registration number as issued by the registrar.
companyRegistrationDatestring?NoThe date on which the merchant's company was formally registered.
adminPasscodestring?NoAn optional admin passcode for POS terminal access control.
logoUrlstring?NoThe publicly accessible URL of the merchant's logo image.
hostedPaymentUrlstring?NoThe URL for this merchant's hosted payment page (VantagePay-generated).
hostedPaymentOptionsobjectNoConfiguration options for a merchant's hosted (online / card-not-present) payment page, including accepted card schemes and settlement timing.
posOptionsobjectNoFeature flags that control which transaction types and capabilities are enabled on a merchant's POS terminals.
businessobjectNoThe legal business entity associated with a merchant, used for KYB verification and settlement.
addressesarray<object>?NoPhysical addresses linked to this merchant.
employeesarray<object>?NoEmployees associated with this merchant.
terminalsarray<object>?NoPOS terminals configured for this merchant.
filesarray<object>?NoFiles uploaded for this merchant (e.g. KYB documents, business registration certificates).
notificationSettingsarray<object>?NoConfigured notification event preferences for this merchant.
attributesarray<object>?NoCustom attribute values associated with this merchant (partner-specific metadata).
bankAccountsarray<object>?NoBank accounts linked to this merchant for settlement.
mobileWalletsarray<object>?NoMobile money wallet accounts linked to this merchant for settlement.
operatingTimesarray<object>?NoThe operating hours configured for this merchant.
devicesarray<object>?NoMobile and POS devices registered to this merchant for push notification delivery.
qrCodesarray<object>?NoEMV QR codes configured for this merchant.
assignedProductReferencesarray<string>?NoThe set of product references (from other merchants) that this merchant has been granted access to in addition to their own products. Sync semantics on admin merchant update: null = caller did not supply the field (no change is applied); empty collection = all existing assignments are cleared; populated collection = assignments are replaced with exactly the supplied set. The self-service merchant update controller strips this field before persistence so only admins can modify merchant product assignments.
referencestring?NoThe system-assigned unique reference (UUID) for this merchant. Assigned on creation; null on new records before persistence.
userReferencestring?NoThe unique reference (UUID) of the authentication user account associated with this merchant profile, if one exists.
yourReferencestring?NoAn optional external reference from the caller's system that identifies this merchant in their own data store.
sourcestring?NoThe identifier of the originating system or partner that registered this merchant.
namestringYesThe trading name of the merchant.
categoryCodeone of 967 values (e.g. 0, 11, 701, ...)YesThe ISO 18245 Merchant Category Code (MCC) that classifies the merchant's type of business.
categorystring?NoThe display name of the merchant category, derived from ZGA.Core.Models.Merchants.BasicMerchant.CategoryCode.
emailAddressstring?NoThe primary contact email address for the merchant.
mobileNumberstring?NoThe primary contact mobile number for the merchant in international MSISDN format.
countryIsoCodeone of 248 values (e.g. None, AFG, ALB, ...)NoThe ISO 3166-1 alpha-3 country code of the country in which the merchant operates.
currencyone of 106 values (e.g. None, AFN, ALL, ...)YesThe ISO 4217 currency in which the merchant transacts.
kybStatusSummaryUnverified, Verified, PartiallyVerified, RejectedNoA summary of the merchant's Know Your Business (KYB) verification status.
shortCodeinteger?NoA short numeric code assigned to the merchant that can be used as a compact identifier in USSD/QR flows.
isActivebooleanNotrue if the merchant account is currently active and able to accept payments.
json
{
  "createdDate": "string",
  "loginCredentials": {
    "username": "string",
    "password": "string",
    "isLockedOut": true,
    "reasonForLockout": "string"
  },
  "tradingName": "string",
  "franchiseName": "string",
  "capturedBy": "string",
  "capturedFrom": "string",
  "industry": "None",
  "phoneNumber": "string",
  "notificationEmailAddress": "string",
  "notificationMobileNumber": "string",
  "city": "string",
  "state": "string",
  "languageIsoCode": "None",
  "webSiteUrl": "string",
  "isRegistrationComplete": true,
  "isEmailVerified": true,
  "isMobileNumberVerified": true,
  "vCard": "string",
  "logoImage": "string",
  "taxNumber": "string",
  "companyRegistrationNumber": "string",
  "companyRegistrationDate": "string",
  "adminPasscode": "string",
  "logoUrl": "string",
  "hostedPaymentUrl": "string",
  "hostedPaymentOptions": {
    "cardNotPresentMID": 0,
    "isVisaEnabled": true,
    "isMastercardEnabled": true,
    "isAmericanExpressEnabled": true,
    "isDinersEnabled": true,
    "settlementTime": "None"
  },
  "posOptions": {
    "isRefundsEnabled": true,
    "isCancellationsEnabled": true,
    "isPurchaseWithCashbackEnabled": true,
    "isWithdrawalsEnabled": true,
    "isBalanceCheckEnabled": true,
    "isCurrencyConversionEnabled": true,
    "isRcsPaymentEnabled": true,
    "isDebiCheckEnabled": true,
    "isPreAuthorizationEnabled": true,
    "isManualCardEntryEnabled": true,
    "isInvoiceNumberEnabled": true,
    "isPasscodeAlwaysRequired": true,
    "fuelPurchaseMethod": "ByAmount"
  },
  "business": {
    "reference": "00000000-0000-0000-0000-000000000000",
    "parentBusinessReference": "00000000-0000-0000-0000-000000000000",
    "createdDate": "string",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "phoneNumber": "string",
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "isActive": true
  },
  "addresses": [
    {}
  ],
  "employees": [
    {}
  ],
  "terminals": [
    {}
  ],
  "files": [
    {}
  ],
  "notificationSettings": [
    {}
  ],
  "attributes": [
    {}
  ],
  "bankAccounts": [
    {}
  ],
  "mobileWallets": [
    {}
  ],
  "operatingTimes": [
    {}
  ],
  "devices": [
    {}
  ],
  "qrCodes": [
    {}
  ],
  "assignedProductReferences": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "reference": "00000000-0000-0000-0000-000000000000",
  "userReference": "00000000-0000-0000-0000-000000000000",
  "yourReference": "string",
  "source": "string",
  "name": "string",
  "categoryCode": 0,
  "category": "string",
  "emailAddress": "string",
  "mobileNumber": "string",
  "countryIsoCode": "None",
  "currency": "None",
  "kybStatusSummary": "Unverified",
  "shortCode": 0,
  "isActive": true
}

Responses

StatusDescription
200The request was successful and the merchants details are updated.
400The request failed validation, the error object will contain further information.
401The authorization information provided is not valid, authentication is required to access this resource.
403The authorization header does not contain the correct type or you do not have access to this resource.
404The request was successful but does not return any results.
422The request payload is invalid, the error object will contain further information.
429Too many requests are being sent concurrently or rate limiting has taken effect.
500An unexpected error occurred, the error object will contain further information.

Response body

FieldTypeRequiredDescription
successbooleanNoGets a value indicating whether the operation was successful.
resultobjectNoFull merchant profile, extending ZGA.Core.Models.Merchants.BasicMerchant with trading details, linked accounts, terminals, employees, addresses, and KYB documentation.
json
{
  "success": true,
  "result": {
    "createdDate": "string",
    "loginCredentials": {},
    "tradingName": "string",
    "franchiseName": "string",
    "capturedBy": "string",
    "capturedFrom": "string",
    "industry": "None",
    "phoneNumber": "string",
    "notificationEmailAddress": "string",
    "notificationMobileNumber": "string",
    "city": "string",
    "state": "string",
    "languageIsoCode": "None",
    "webSiteUrl": "string",
    "isRegistrationComplete": true,
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "vCard": "string",
    "logoImage": "string",
    "taxNumber": "string",
    "companyRegistrationNumber": "string",
    "companyRegistrationDate": "string",
    "adminPasscode": "string",
    "logoUrl": "string",
    "hostedPaymentUrl": "string",
    "hostedPaymentOptions": {},
    "posOptions": {},
    "business": {},
    "addresses": [],
    "employees": [],
    "terminals": [],
    "files": [],
    "notificationSettings": [],
    "attributes": [],
    "bankAccounts": [],
    "mobileWallets": [],
    "operatingTimes": [],
    "devices": [],
    "qrCodes": [],
    "assignedProductReferences": [],
    "reference": "00000000-0000-0000-0000-000000000000",
    "userReference": "00000000-0000-0000-0000-000000000000",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "categoryCode": 0,
    "category": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "countryIsoCode": "None",
    "currency": "None",
    "kybStatusSummary": "Unverified",
    "shortCode": 0,
    "isActive": true
  }
}

Code samples ​

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

csharp
var merchant = await adminClient.Merchants.GetMerchantAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));
merchant!.TradingName = "Acme Superstore";
var updated = await adminClient.Merchants.UpdateMerchantAsync(merchant);

Delete a merchant. ​

DELETE /v1/merchant/admin/{merchantReference}

Sample

json
DELETE /v1/merchant/admin/e5d751c6-aa78-4d92-a1f1-fcdf776a57d7/ZGA

Auth: API key (VantagePayAdminClient).

Parameters

NameInRequiredDescription
merchantReferencepathYesA globally unique internal merchant reference (UUID).

Responses

StatusDescription
200The request was successful and the merchant was deleted.
400The request failed validation, the error object will contain further information.
401The authorization information provided is not valid, authentication is required to access this resource.
403The authorization header does not contain the correct type or you do not have access to this resource.
404The request was successful but does not return any results.
422The request payload is invalid, the error object will contain further information.
429Too many requests are being sent concurrently or rate limiting has taken effect.
500An unexpected error occurred, the error object will contain further information.

Response body

FieldTypeRequiredDescription
successbooleanNoGets a value indicating whether the operation was successful.
json
{
  "success": true
}

Code samples ​

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

csharp
await adminClient.Merchants.DeleteMerchantAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

Get merchant information. ​

GET /v1/merchant/admin/{merchantReference}

Sample

json
GET /v1/merchant/admin/e5d751c6-aa78-4d92-a1f1-fcdf776a57d7/ZGA

Auth: API key (VantagePayAdminClient).

Parameters

NameInRequiredDescription
merchantReferencepathYesA globally unique internal merchant reference (UUID).

Responses

StatusDescription
200The request was successful and the merchant information was returned.
400The request failed validation, the error object will contain further information.
401The authorization information provided is not valid, authentication is required to access this resource.
403The authorization header does not contain the correct type or you do not have access to this resource.
404The request was successful but does not return any results.
422The request payload is invalid, the error object will contain further information.
429Too many requests are being sent concurrently or rate limiting has taken effect.
500An unexpected error occurred, the error object will contain further information.

Response body

FieldTypeRequiredDescription
successbooleanNoGets a value indicating whether the operation was successful.
resultobjectNoFull merchant profile, extending ZGA.Core.Models.Merchants.BasicMerchant with trading details, linked accounts, terminals, employees, addresses, and KYB documentation.
json
{
  "success": true,
  "result": {
    "createdDate": "string",
    "loginCredentials": {},
    "tradingName": "string",
    "franchiseName": "string",
    "capturedBy": "string",
    "capturedFrom": "string",
    "industry": "None",
    "phoneNumber": "string",
    "notificationEmailAddress": "string",
    "notificationMobileNumber": "string",
    "city": "string",
    "state": "string",
    "languageIsoCode": "None",
    "webSiteUrl": "string",
    "isRegistrationComplete": true,
    "isEmailVerified": true,
    "isMobileNumberVerified": true,
    "vCard": "string",
    "logoImage": "string",
    "taxNumber": "string",
    "companyRegistrationNumber": "string",
    "companyRegistrationDate": "string",
    "adminPasscode": "string",
    "logoUrl": "string",
    "hostedPaymentUrl": "string",
    "hostedPaymentOptions": {},
    "posOptions": {},
    "business": {},
    "addresses": [],
    "employees": [],
    "terminals": [],
    "files": [],
    "notificationSettings": [],
    "attributes": [],
    "bankAccounts": [],
    "mobileWallets": [],
    "operatingTimes": [],
    "devices": [],
    "qrCodes": [],
    "assignedProductReferences": [],
    "reference": "00000000-0000-0000-0000-000000000000",
    "userReference": "00000000-0000-0000-0000-000000000000",
    "yourReference": "string",
    "source": "string",
    "name": "string",
    "categoryCode": 0,
    "category": "string",
    "emailAddress": "string",
    "mobileNumber": "string",
    "countryIsoCode": "None",
    "currency": "None",
    "kybStatusSummary": "Unverified",
    "shortCode": 0,
    "isActive": true
  }
}

Code samples ​

WARNING

The JavaScript SDK does not cover admin APIs - use the .NET SDK.

csharp
var merchant = await adminClient.Merchants.GetMerchantAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

Payments for Africa

© VantagePay 2026