Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Description

The APItokenToCompanyCode will give you the company code according to the company token provided

URL: https://secure1.sandbox.directpay.online/API/v6/


Response

The method will response with the result of your request


Variables to send:

Parameter

Data type

Description


 Request

 Text

 APItokenToCompanyCode

Mandatory

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

companyAPItokenUNQ

Token

Token you got from 3G customer

Mandatory

Request example:


request example
<API3G>
  <CompanyToken>68B90B5E-23F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <Request>APItokenToCompanyCode</Request>
  <companyAPItokenUNQ>72983CAC-5DB1-4C7F-BD88-352066B71592</companyAPItokenUNQ>
</API3G>


Respond:

The server will respond for the APItokenToCompanyCode request according to the following results:

Parameter

Data type

Description

Result

3 digits code

A code will be sent with the result of the request
000 – Found
700 – Not found

ResultExplanation

Text

Free text of the result

companyCode

Text

Company code to use

CompanyName

Text

Company Name

BrandName

Text

Company Brand name

websiteURL

Text

Company website

CompanyEmail

Text

Company e-mail

NotificationEmail

Text

Company notification e-mail

CompanyAddress

Text

Company address

CompanyCountry

Text

Company country

CompanyMarket

Text

Company market

Respond example:


response example
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
   <Result>000</Result>
   <ResultExplanation>Found</ResultExplanation>
   <companyCode>demo1</companyCode>
   <CompanyName>3GDP TEST ACCOUNT</CompanyName>
   <BrandName>3GDP TEST ACCOUNT</BrandName>
   <websiteURL>http://www.domain.com</websiteURL>
   <CompanyEmail>test@3gdirectpay.com</CompanyEmail>
   <NotificationEmail />
   <CompanyAddress>Company HQ address goes here</CompanyAddress>
   <CompanyCountry>United kingdom</CompanyCountry>
   <CompanyMarket>Mauritius</CompanyMarket>
</API3G>


Response codes:

Code

Explanation

000

Found

700

Not found

801

Request missing company token

802

Wrong CompanyToken

803

No request or error in Request type name

804

Error in XML



  • No labels