Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

...

Parameter

Data type

Description


CompanyTokenTokenToken you got from 3G to operate this APIMandatory

 Request

 Text

 verifyToken

Mandatory

TransactionToken

Token

Transaction token as accepted from the URL redirected

Mandatory/Optional if CompanyRef is sent

CompanyRefTextCompany reference number

Mandatory/Optional if TransactionToken is sent

VerifyTransaction

Boolean (1/0)

By default, the system will verify the transaction and mark it as “website verified” in 3G systems.
This option should be set to false if you only want to verify the transaction was made, process the details and then you can send the verifyToken again with this parameter set to true to let 3G systems know that you have successfully processed the client.

Send 1 to verify, 0 if you don't need.

Optional

Default: 1 (True)

ACCref

Text

Internal accounting reference number.

Optional

customerPhone

Text

Customer phone number can be updated

Optional/Mandatory if customerPhonePrefix sent

customerPhonePrefix

Number

Customer phone prefix (without +)

Optional/Mandatory if customerPhone sent

customerEmail

Text

Customer E-mail address can be updated

Optional

...

Code Block
languagexml
titleresponse example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <Result>000</Result>
    	<ResultExplanation>Transaction Paid</ResultExplanation>
	<TransactionCreatedDate>2023/08/25 09:27:08</TransactionCreatedDate>
	<TransactionSettlementDate>2023/09/04</TransactionSettlementDate>
	<TransactionRollingReserveAmount>0.00</TransactionRollingReserveAmount>
	<TransactionRollingReserveDate>2023/08/25</TransactionRollingReserveDate>
	<TransactionExpiryDate>2023/08/25 14:27:08</TransactionExpiryDate>
	<TransactionPaymentDate>2023/08/25 09:42:33</TransactionPaymentDate>
	<CustomerName>Cons Connie </CustomerName>
	<CustomerPhone>706527126</CustomerPhone>
	<CustomerCountry>Kenya</CustomerCountry>
	<CustomerAddress></CustomerAddress>
	<CustomerCity>Mbsa</CustomerCity>
	<CustomerZip></CustomerZip>
	<CustomerEmail>koyoreads@gmail.com</CustomerEmail>
	<PaymentType></PaymentType>
	<CardType>Mobile</CardType>
	<ApprovalNumber>RHP2ZIGD5U</ApprovalNumber>
	<CardLastFour></CardLastFour>
	<CardFirstSix></CardFirstSix>
	<TransactionAmount>1.0000</TransactionAmount>
	<TransactionCurrency>KES</TransactionCurrency>
	<PartPaymentRef>0</PartPaymentRef>
	<AllocationAmount></AllocationAmount>
	<AllocationCode></AllocationCode>
	<CompanyRef></CompanyRef>
	<CompanyAccRef></CompanyAccRef>
	<TransactionRef>R49500190</TransactionRef>
	<ServiceDescription>Sstream.co.ke Order for Stream tech test</ServiceDescription>
	<ServiceDate></ServiceDate>
	<TransactionFraudAlert>001</TransactionFraudAlert>
	<TransactionFraudExplanation>Low Risk (Not checked)</TransactionFraudExplanation>
	<TransactionFinalAmount>1.0000</TransactionFinalAmount>
	<TransactionFinalCurrency>KES</TransactionFinalCurrency><CustomerName>Cons Connie </CustomerName>
	<CustomerCredit></CustomerCredit>
	<CustomerCreditType>Mobile</CustomerCreditType>
	<TransactionApproval>RHP2ZIGD5U</TransactionApproval>
	<TransactionCurrency>KES</TransactionCurrency>
	<TransactionAmount>1.00</TransactionAmount>
	<FraudAlert>001</FraudAlert>
	<FraudExplnation>Low Risk (Not checked)</FraudExplnation>
	<TransactionNetAmount>0.99</TransactionNetAmount>
	<TransactionSettlementDate>2023/09/04</TransactionSettlementDate>
	<TransactionRollingReserveAmount>0.00</TransactionRollingReserveAmount>
	<TransactionRollingReserveDate>2023/08/25</TransactionRollingReserveDate>
	<CustomerPhone>706527126</CustomerPhone>
	<CustomerCountry>Kenya</CustomerCountry>
	<CustomerAddress></CustomerAddress>
	<CustomerCity>Mbsa</CustomerCity>
	<CustomerZip></CustomerZip>
	<MobilePaymentRequest>Not sent</MobilePaymentRequest>
	<AccRef></AccRef>
	<TransactionFinalCurrency>KES</TransactionFinalCurrency>
	<TransactionFinalAmount>1.00</TransactionFinalAmount>
</API3G>