updateToken

Description

The updateToken request will be used to modify existing transaction data.

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

Response

The method will return the operation result.

 

Variables to send:

Parameter

Data type

Description


 Request

 Text

 updateToken

Mandatory

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

TransactionToken

Token

Transaction token as accepted from the createToken.

Mandatory

PaymentAmount

money

Transaction amount, up to 2 decimal

Optional

CompanyRefTextCompany reference numberOptional
CustomerEmailTextE-mail of the customer to send the linkOptional
CustomerFirstNameTextCustomer nameOptional
CustomerLastNameTextCustomer last nameOptional
CustomerAddressTextCustomer addressOptional
CustomerCityTextCustomer cityOptional
CustomerCountryISO codeCustomer country ISO 2 letter code
http://en.wikipedia.org/wiki/ISO_3166-1
Optional
CustomerDialCodeISO codeCustomer country ISO 2 letter code
http://en.wikipedia.org/wiki/ISO_3166-1
Optional
CustomerPhoneNumberCustomer Phone numberOptional
CustomerZipTextCustomer zip codeOptional
CompanyAccRefTextInternal accounting reference numberOptional
UserTokenTokenTo define who created the transactionOptional

 

Request example:


request example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <Request>updateToken</Request>
  <TransactionToken>EC9E975A-A7A2-4031-8972-BF123CDD9EDD</TransactionToken>
  <PaymentAmount>44</PaymentAmount>
  <CompanyRef>DPO1212</CompanyRef>
  <CustomerEmail>test@directpay.online</CustomerEmail>
  <CustomerFirstName>Steven dsa</CustomerFirstName>
  <CustomerLastName>Muallem</CustomerLastName>
  <CustomerAddress>Rose Avenue 6 </CustomerAddress>
  <CustomerCity>Nairobi</CustomerCity>
  <CustomerCountry>KE</CustomerCountry>
  <CustomerDialCode>KE</CustomerDialCode>
  <CustomerPhone>4433332312</CustomerPhone>
  <CustomerZip>121212</CustomerZip>
  <CompanyAccRef>DPO3232</CompanyAccRef>
  <UserToken>3DBC6853-8352-4902-8370-C6B38C379999E</UserToken>
</API3G>


Respond:

The server will respond for the updateToken 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

ResultExplanation

Text

Free text of the result

Respond codes:

 

Code

Explanation

000

Token been updated

999

Custom error message

804

Error in XML

950

Request missing transaction level mandatory fields

 

Respond example:


response example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <Result>000</Result>
    <ResultExplanation>Token been updated</ResultExplanation>
</API3G>