getTransactionByRef

Description

Returns all transactions with the same booking ref

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

Response

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	Mandatory
userToken	Token	Using this field will return all transactions created by specified user	Optional
allTrans	Boolean	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

Request example:

<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <CompanyToken>DC6405AA-A025-4B8B-989B-A8921DD31094</CompanyToken>
    <Request>getTransactionByRef</Request>
    <CompanyRef>Testref</CompanyRef>
    <userToken>26E692C5-4F6F-46CA-AE86-6007DBDE4DDA</userToken>
    <allTrans>1</allTrans>
    <descOrder>1</descOrder>
</API3G>

Response example:

<?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>
            <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>
            <TransactionAdditionalFields>{"TravTransTypeCd":"Type1","DocTypeCd":"DocType","IATACarrierCd":"1234","IATAAgcyNbr":"465657","TktCarrierNm":"CarrierNm","TktIssCityNm":"Nairobi","PassCnt":"3","ConjTktInd":"12233","ElecTktInd":"1A848F","ExchTktNbr":"1A848E5","SegIATACarrierCd":"Some data","FareBasisTxt":"BasisTxt","FlgtNbr":"1A848EF","ServClassCd":"1A"}</TransactionAdditionalFields>
        </Transaction>
	</Transactions>
</API3G>