pushPayments

Description

DPO will push automatically the notification after successful payment to provided URL.

Usage

This API will notify merchant for each successful payment

Response

Merchant must return 'OK' to approve

The server will push for the pushPayments API according to the following parameters:

Parameter	Data type	Description
Result	3 digits code	A code will be sent with the result of the request
ResultExplanation	Text	Free text of the result
TransactionToken	Token	Token of the transaction
TransactionRef	Text	Reference sent during createToken API
CustomerName	Text	Customer name as filled in the form of 3GDirectpay payment page
CustomerCredit	Text	4 digits of credit card Will be sent if transaction paid by credit card
CustomerCreditType	Text	Credit card type
TransactionApproval	Text	Transaction approval number
TransactionCurrency	Text	Currency final payment (the customer can convert the payment)
TransactionAmount	Money	Paid amount
FraudAlert	3 digits code	According to fraud codes table
FraudExplnation	Text	Free text of fraud analysis
TransactionNetAmount	Money	NET transaction amount
TransactionSettlementDate	Date	Date of transaction settlement
TransactionRollingReserveAmount	Money	Transaction rolling reserve amount
TransactionRollingReserveDate	Date	Date of rolling reserve release
CustomerPhone	Text	Customer phone number
CustomerCountry	Text	Customer country
CustomerAddress	Text	Customer address
CustomerCity	Text	Customer city
CustomerZip	Text	Customer zip code
MobilePaymentRequest	Text	Mobile payment request status
AccRef	Text	Internal accounting reference number

Respond example:

response example

<?xml version=\"1.0\" encoding=\"utf-8\"?>
<API3G>
  <Result>000</Result>
  <ResultExplanation>Transaction paid</ResultExplanation>
  <TransactionToken>68B90B5E-25F6-4146-8AB1-G5B3A0C41N9E</TransactionToken>
  <TransactionRef>A123BEWDSD</TransactionRef>
  <CustomerName>John Doe</CustomerName>
  <CustomerCredit>4432</CustomerCredit>
  <TransactionApproval>938204312</TransactionApproval>
  <TransactionCurrency>USD</TransactionCurrency>
  <TransactionAmount>950.00</TransactionAmount>
  <FraudAlert>000</FraudAlert>
  <FraudExplnation>No Fraud detected</FraudExplnation>
  <TransactionNetAmount>945</TransactionNetAmount>
  <TransactionSettlementDate>2013/12/31</TransactionSettlementDate>
  <TransactionRollingReserveAmount>5</TransactionRollingReserveAmount>
  <TransactionRollingReserveDate>2014/12/31</TransactionRollingReserveDate>
  <CustomerPhone>254123456789</CustomerPhone>
  <CustomerCountry>KE</CustomerCountry>
  <CustomerAddress>Stranfe blvd.</CustomerAddress>
  <CustomerCity>Nairobi</CustomerCity>
  <CustomerZip>AH1</CustomerZip>
  <MobilePaymentRequest>Sent</MobilePaymentRequest>
  <AccRef>ABC123REF</AccRef>
</API3G>

Call back variables:

Parameter	Data type	Description
Response	Text	Must return "OK" to confirm push payment	Mandatory
CompanyRef	Text	Company reference number. Can update transaction CompanyRef on call back	optional
AccRef	Text	Internal accounting reference number. Can update transaction AccRef on call back	optional

Call back example:

response example

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <Response>OK</Response>
</API3G>

Codes in Fraud Alert:

Code	Explanation
000	Genuine transaction
001	Low Risk (Not checked)
002	Suspected Fraud Alert
003	Fraud alert cleared (Merchant marked as clear)
004	Suspect Fraud Alert
005	Fraud alert cleared (Genuine transaction)
006	Black - Fraudulent transaction