Successful Status
  • 21 Dec 2023
  • 1 Minute to read
  • Dark
    Light

Successful Status

  • Dark
    Light

Article summary

This will return all the transaction events with the status of successful 

POST - /api/v1/query 

query getVisibleTransactions 
(  
          $startDate: String!, $endDate: String!, $sort: TransactionSort!,  
          $status: String! , $page: Int, $size: Int 
 )  
{ 
   events( 
     from: $startDate, 
     to: $endDate, 
     visible: true, 
     status: $status, 
     sort: $sort, 
     excludeType: [ 
       "DISPUTE_RECEIVED", "DISPUTE_APPLIED", "DISPUTE_REVERSED", 
       "DISPUTE_CANCELLED" 
     ], 
    page: $page, 
     size: $size 
   )  
  { 
 transactionEventList { 
       id 
      eventId 
      ownerId 
      eventType 
       summary { 
          visible 
           type 
           status 
      } 
    customer { 
           name 
             } 
    paymentMethod 
    { 
           providerResponse { 
                 methodUsed 
           } 
           card { 
                 cardScheme 
            } 
  } 
     transaction { 
         transactionId 
         receivedDateTime 
         amount 
         description 
         merchantReference 
         currency 
      } 
    } 
    totalCount 
  } 
} 

{ 
         "sort": { 
             "field": "receivedDateTime", 
             "direction": "DESC" 
         }, 
         "startDate": "1899-12-31T22:15:36.000Z", 
         "endDate": "2022-11-05T03:16:26.274Z", 
         "status": " SUCCESSFUL", 
         "page": 0, 
         "size": 10 
 } 

 Notes for Request Body 

  • Default structure of request body will be same. Only addition of filter in query is done as highlighted above. 

  • Possible value for status see summary.status under Transaction Data Dictionary    


Was this article helpful?

What's Next