Versions Compared

Key

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

...

The method will respond with the result of your request.

Variables to send:

Parameter

Data type

Description

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

Request

Text

getTransactionByRef

Mandatory

CompanyRef

Text

Booking Reference

Optional (Mandatory - if empty TransactionToken)

userToken

Token

Using this field will return all transactions created by specified user

Optional

allTrans

Boolean

Sending false with this parameter will return only paid transactions, else will return all transactions

Status of transaction
0 - Paid
1 - All (default)
2 - Cancelled
3 - Authorised
4 - Queued Auth

Optional

descOrder

Boolean

Sending this with true will return all results in the opposite order

Optional

TransactionToken

Token

Transaction Token

Optional (Mandatory - if empty CompanyRef)

Request example:

Code Block
languagexml
<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <CompanyToken>DC6405AA-A025-4B8B-989B-A8921DD31094</CompanyToken>
    <Request>getTransactionByRef</Request>
    <TransactionToken>9F68A4F5-149B-4473-A636-AF6F7610CDBA</TransactionToken>
    <CompanyRef>Testref</CompanyRef>
    <userToken>26E692C5-4F6F-46CA-AE86-6007DBDE4DDA</userToken>
    <allTrans>1</allTrans>
    <descOrder>1</descOrder>
</API3G>

Response example:

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>

...

<API3G>
    <Code>000</Code>

...

    <Explanation>Results Found</Explanation>
   

...

 <Transactions>

...


        <Transaction>
            <TransactionBookRef>49FKQOB</TransactionBookRef>
            <TransactionToken>695DC0F9-2CA7-4C52-99EF-0BBBBB4C776E</TransactionToken>
            <TransactionCreatedDate>2015-09-10 12:00:57</TransactionCreatedDate>
            <TransactionAmount>50.00</TransactionAmount>
            <TransactionCurrency>KES</TransactionCurrency>
            <TransactionNetAmount>1.00</TransactionNetAmount>
            <TransactionSettlementDate>2015-09-10</TransactionSettlementDate>
            <TransactionRollingReserveAmount>0.00</TransactionRollingReserveAmount>
            <TransactionRollingReserveDate></TransactionRollingReserveDate>
            <TransactionFinalAmount>50.00</TransactionFinalAmount>
            <TransactionFinalCurrency>KES</TransactionFinalCurrency>
            <TransactionCreditCard></TransactionCreditCard>
            <TransactionPartPayment>0</TransactionPartPayment>
            <TransactionCityId>0</TransactionCityId>
            <TransactionPhone>0717967449</TransactionPhone>
            <TransactionPhonePrefix>254</TransactionPhonePrefix>
            <TransactionRef>841695DC</TransactionRef>
            <TransactionStatus>Authorised</TransactionStatus>
            <TransactionPaymentDate>2015-09-10 12:03:33</TransactionPaymentDate>
            <TransactionCardType>Cellulant</TransactionCardType>
            <TransactionUserName>System</TransactionUserName>
            <TransactionApprovalNumber>28C399A4-0086-4986-854A-94D7711BBEF9</TransactionApprovalNumber>
            <TransactionServiceDescription>
                <ServiceDescription>Flight</ServiceDescription>
            </TransactionServiceDescription>
            <TransactionCustomerPhone>2540717967449</TransactionCustomerPhone>
            <TransactionCustomerEmail>kate@3gdirectpay.com</TransactionCustomerEmail>
            <TransactionCustomerName>Kate Kate</TransactionCustomerName>
            <TransactionFraudAlert>001</TransactionFraudAlert>
            <TransactionFraudExplanation>Low Risk (Not checked)</TransactionFraudExplanation>
            <TransactionExpiryDate>2015-09-14 09:00:57</TransactionExpiryDate>
            <TransactionAdditionalAirlineFields>
				<TicketType>TICKET_PURCHASE</TicketType>
				<DocumentType>ADDITIONAL_COLLECTION</DocumentType>
				<DateIssued>2013/12/20 19:00</DateIssued>
				<IATACarrierCode>CP</IATACarrierCode>
				<IATATravelAgencyNbr>CPT</IATATravelAgencyNbr>
				<TicketCarrierName>KenyaAirways</TicketCarrierName>
				<TicketIssuerCityName>Nairobi</TicketIssuerCityName>
				<PassengerCount>3</PassengerCount>
				<ConjTicketIndicator>12233</ConjTicketIndicator>
				<ElecTicketIndicator>1A848F</ElecTicketIndicator>
				<ExchTicketIndicator>1A848E5</ExchTicketIndicator>
				<FlightLegDetails>
					<FlightLeg>
						<FlightDescription>Flight from TelAviv to CapeTown</FlightDescription>
						<FlightType>45</FlightType>
						<FlightDate>2013/12/20 19:00</FightDate>
						<FlightFrom>TLV</FlightFrom>
						<FlightTo>CPT</FightTo>
						<FlightRef>1234ABC</FlightRef>
						<CarrierCode>AI</CarrierCode>
						<ServiceClass>A</ServiceClass>
						<FlightNumber>101</FlightNumber>
						<FareBasisCode>SPRSVR</FareBasisCode>
						<StopOverCode>X</StopOverCode>
					</FlightLeg>
					<FlightLeg>
						<FlightDescription>Flight from CapeTown to TelAviv</FlightDescription>
						<FlightType>45</FlightType>
						<FlightDate>2013/12/21 16:00</FightDate>
						<FlightFrom>CPT</FlightFrom>
						<FlightTo>TLV</FightTo>
						<FlightRef>1234ABC</FlightRef>
						<CarrierCode>AI</CarrierCode>
						<ServiceClass>A</ServiceClass>
						<FlightNumber>101</FlightNumber>
						<FareBasisCode>SPRSVR</FareBasisCode>
						<StopOverCode>X</StopOverCode>
					</FlightLeg>
				</FlightLegDetails>
				<Travellers>
					<Traveler>
						<TravelerFirstName>John</TravelerFirstName>
						<TravelerLastName>Doe</TravelerLastName>
						<TravelerPhone>456887014</TravelerPhone>
						<TravelerPhonePrefix>123</TravelerPhonePrefix>
						<TravelerDateOfBirth>2001/12/21</TravelerDateOfBirth>
						<TravelerCountryCode>US</TravelerCountryCode>
					</Traveler>
					<Traveler>
						<TravelerFirstName>Rose</TravelerFirstName>
						<TravelerLastName>Doe</TravelerLastName>
					</Traveler>
				</Travellers>
			</TransactionAdditionalAirlineFields>
			<MetaData>
              <![CDATA[
              {
              "key": "Value",
              .......
              }
              ]]>
            </MetaData>
            <Additional>
				<BlockPayment>PP</BlockPayment>
				<BlockPayment>BT</BlockPayment>
			</Additional>
			<RedirectUrl>https://redirect.com</RedirectUrl>
			<BackUrl></BackUrl>
			<DeclinedUrl></DeclinedUrl>
        </Transaction>
	</Transactions>
</API3G>