getMoneyOut

getMoneyOut

Description

Request to this API will return a list of settled amounts and their dates for the selected merchants based on the timestamps.

 

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

Response:

The method will respond with the result of your request

 

 

Variables to send:

Parameter

Data type

Description

 

Parameter

Data type

Description

 

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

Request

text

getMoneyOut

Mandatory

startTimeStamp

timestamp

Timestamp of the start date

Mandatory

endTimeStamp

timestamp

Timestamp of the end date

Mandatory

Currency

text

will return the result based on the selected currency

Mandatory

 

Request example:

<?xml version="1.0" encoding="utf-8"?> <API3G> <CompanyToken>BD0B25BD-4F7E-49B0-80CD-37C2BF6F6368</CompanyToken> <Request>getMoneyOut</Request> <Currency>Kes</Currency> <startTimeStamp>1744792540</startTimeStamp> <endTimeStamp>1745310604</endTimeStamp> </API3G>

 

Response example:

The server will respond to the getMoneyOut request according to the following results:

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

 

Codes in response:

Code

Explanation

Code

Explanation

000

Request was valid

 

Success result example:

 

<?xml version="1.0" encoding="UTF-8"?> <API3G><Code>000</Code> <Explanation>Success</Explanation> <TotalSettlementAmount>0.00</TotalSettlementAmount> <SettlementResults> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-16</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-17</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-18</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-19</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-20</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-21</SettlementDate> </Results> <Results> <Amount>0.00</Amount> <SettlementDate>2025-04-22</SettlementDate> </Results> </SettlementResults> </API3G>