Search by DPO ref V7

Description

The getSearchByRef request will check the details about the transaction and give a response

URL: https://secure.3gdirectpay.com/API/v7/

Usage

Used to Transaction using DPO REF

Response

The method will response with the result of your request

Variables to Send:

Parameter	Data Type	Description

Parameter

Data Type

Description

Request

Text

getSearchByRef

Mandatory

CompanyToken

Text (Token - UUID)

Token you got from 3G to operate this API

Mandatory

TransRef

Text

TransRef to be passed)

Mandatory TransRed is sent.

request for example:

<?xml version="1.0" encoding="utf-8"?>
<API3G>
    <CompanyToken>7B3933C9-EFCD-45B4-B33F-CE0AF3D533DC</CompanyToken>
    <Request>getSearchByRef</Request>
    <TransactionRef>R963815</TransactionRef>
    
</API3G>

Response:

The server will respond for the Verifyrefund request according to the following results, the response can be an array (Refunds) if the transaction had multiple refunds.

Parameter	Data Type	Description

Parameter	Data Type	Description
Code	3 digits code	A code will be sent with the result of the request
Explanation	Text	Free text of the result
all the other details of the transaction follow

Codes in the response:

Code	Explanation

Code	Explanation
000	Results Found
001	Request missing company token
950	Request missing transaction level mandatory fields/Data mismatch - field name

response:

Sample Successful Response

<?xml version="1.0" encoding="UTF-8"?>
<API3G><Code>000</Code>
    <Explanation>Result found</Explanation>
    <TransactionBookRef>SGPM</TransactionBookRef>
    <TransactionToken>216DD7BE-DD23-4F2D-B1C5-6DC98AF0F811</TransactionToken>
    <TransactionCreatedDate>2022-07-25 09:33:32</TransactionCreatedDate>
    <TransactionFinalAmount>.0000</TransactionFinalAmount>
    <TransactionCreditCard>4111116476761111</TransactionCreditCard>
    <TransactionPhone>22222223312423</TransactionPhone>
    <TransactionPhonePrefix></TransactionPhonePrefix>
    <TransactionRef>R4963815</TransactionRef>
    <TransactionPaymentDate></TransactionPaymentDate>
    <TransactionCardType></TransactionCardType>
    <TransactionCustomerPhone></TransactionCustomerPhone>
    <TransactionCustomer>asss asassa</TransactionCustomer>
    <TransactionApproval></TransactionApproval>
    <TransactionFraudAlert>001</TransactionFraudAlert>
    <TransactionEmail>asdd@adsd.ss</TransactionEmail>
    <TransactionStatus>Declined</TransactionStatus>
</API3G>

Sample Successful Response if Multiple refunds on a transaction

<?xml version="1.0" encoding="UTF-8"?>
<API3G><Code>000</Code>
    <Explanation>Results Found</Explanation>
    <Refunds>
        <Refund><Code>003</Code>
            <RefundStatus>Automated done</RefundStatus>
            <RefundDate>2022-08-31 14:36:34</RefundDate>
            <RefundAmount>1.0000</RefundAmount>
        </Refund>
        <Refund><Code>003</Code>
            <RefundStatus>Automated done</RefundStatus>
            <RefundDate>2022-08-31 14:48:44</RefundDate>
            <RefundAmount>1.0000</RefundAmount>
        </Refund>
        <Refund><Code>003</Code>
            <RefundStatus>Automated done</RefundStatus>
            <RefundDate>2022-08-31 14:48:49</RefundDate>
            <RefundAmount>1.0000</RefundAmount>
        </Refund>
    </Refunds>
</API3G>

Sample failed response: