Summary Status API

End Point

The Summary Status end point allows us to inform the merchant about the status of a transaction . For example, Let’s Say that the transaction X has a 10€ deposit and a partial refund of 3€, The list of operations and the summary of 7€ deposit will be sent to the merchant.

In order to be able to make an API call merchant will need to encrypt the information with a token. Also the merchant will need to set the Accept header on the request as “application/xml” or “application/json” in order to get the response in xml or json format.

Summary Status Request Parameters:

  • merchantId : Id of the merchant in our system. (Required)
  • encrypted : ref to Hosted Payment Gateway API Guide.  It need to be encrypted a JSON with the parameters:
    • merchantTransactionId: Id of the transaction for the merchant. (Required)
    • merchantId: Id of the merchant in our system (Optional)
  • integrityCheck : ref to Hosted Payment Gateway API Guide

Summary Status Response Parameters:

  • operations[] :
    • amount
    • currency
    • merchantTransactionId
    • operationType
    • payFrexTransactionId
    • paymentSolution
    • status
  • summary :
    • amount
    • currency
    • merchantTransactionId
    • operationType: {debit, credit}
    • status

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<epg-summary-status-response message="Operations related with 0001, #2 results" operation-size="2" epg-status="SUCCESS">
 <operations>
  <operation>
   <amount>10.00</amount>
   <currency>GBP</currency>
   <merchantTransactionId>0001</merchantTransactionId>
   <operationType>DEBIT</operationType>
   <payFrexTransactionId>20961696</payFrexTransactionId>
   <paymentSolution>Paypal</paymentSolution>
   <status>SUCCESS</status>
  </operation>
  <operation>
   <amount>10.00</amount>
   <currency>GBP</currency>
   <merchantTransactionId>0001</merchantTransactionId>
   <message>REBATE: </message>
   <operationType>REFUND</operationType>
   <originalPayFrexTransactionId>20961696</originalPayFrexTransactionId>
   <payFrexTransactionId>20961698</payFrexTransactionId>
   <paymentSolution>Paypal</paymentSolution>
   <status>SUCCESS</status>
  </operation>
 </operations>
 <summary>
  <amount>10.00</amount>
  <currency>GBP</currency>
  <merchantTransactionId>0001</merchantTransactionId>
  <operationType>REFUND</operationType>
  <status>SUCCESS</status>
 </summary>
</epg-summary-status-response>
Cookies Policy We need our cookies to make Easy Payment Gateway better. If you need more information click here.