Response
  • 30 Nov 2023
  • 1 Minute to read
  • Dark
    Light

Response

  • Dark
    Light

Article summary

A HTTP 200 response body will return the following. Additionally, a response header ‘X-Total-Count’ included indicating total no of records matching given request. This would be useful to calculate no of pages that can be used for navigation. 

Entity 

Sub-entity 

Sub-sub-entity 

Sub-sub-sub-entity 

Description 

dateFrom 

 

 

 

As given in the request query parameter “dateFrom”, if not given returns earliest payout date from the remittance records identified 

dateTo 

 

 

 

As given in the request query parameter “dateTo”, if not given returns latest payout date from the remittance records identified 

merchantId 

 

 

 

As given in the request url path parameter 

bankAccountId 

 

 

 

Array of bank account ids to filter based on given request query parameter “bankAccountId”. If not given in the request, will return the ids already stored. 

transactions 

(Array of Transactions) 

 

 

 

Array of remittance processed transactions 

 

transactionId 

 

 

Integer  
Uniquely identifies the transaction 

 

transactionDate 

 

 

Datetime of the transaction  

Format: YYYY-MM-DDThh:mm:ss 

 

expectedRemittanceDate 

 

 

Date of expected remittance  

(This can be used to identify whether the transaction has been delayed due to pre-approval for example.) 

Format: YYYY-MM-DD  

 

processType 

 

 

Values: “BACS” or “FP” 

 

paymentMethod 

 

 

Values:   

CARD  

PAY_BY_BANK_ACCOUNT  

APPLE_PAY  

GOOGLE_PAY  

 

type 

 

 

Values:  

For credit transactions   

“PAYMENT”  

“CHARGEBACK_REVERSAL”  

“CREDIT_CHARGEBACK”  

For debit transactions  

“REFUND”  

“CHARGEBACK”  

“CREDIT_CHARGEBACK_REVERSAL”  

 

 

transactionAmount 

 

 

Decimal 

For credit transactions - Total amount processed. This includes payments, credit chargebacks and chargeback reversals For debit transactions - Total amount to be recovered. This includes refunds, chargebacks and credit chargeback reversals 

 

feeAmount 

 

 

Decimal  

Transaction fee to be recovered 

 

payoutAmount 

 

 

Decimal  

Transaction amount to be paid out (transactionAmount minus feeAmount) 

 

runId 

 

 

String   

Remittance run id 

 

Items 

(Array of transaction line items) 

 

 

 

 

 

lineId 

 

String 

Customers identifier for the line item 

 

 

transactionAmount 

 

Decimal 

For credit transactions - Item amount to be processed. This includes payments, credit chargebacks and chargeback reversals  

For debit transactions - Total amount to be recovered. This includes refunds, chargebacks and credit chargeback reversals 

 

 

feeAmount 

 

Decimal 

Item fee to be recovered 

 

 

payoutAmount 

 

Decimal 

Item amount to be paid out (transactionAmount minus feeAmount) 

 

 

remittanceReference 

 

String 

 

 

narrative 

 

String 

 

 

bankAccountId 

 

String 

 

 

accountNumber 

 

String (masked to show the last 4 digits only 

 

 

sortCode 

 

String 

 

 

bankAccountHolderName 

 

String 

 

 

payoutDate 

 

Date  

Format: YYYY-MM-DD 

Notes

Sort order 

  • Exported transactions would be returned in the order of payout date descending order. 

Max limit on transactions that can be returned from Api. 

  • Returns 400 when no of transactions returned exceeds max limit of transactions configured. 

Following are the optional parameters to be provided in the query string. If not provided, then will return all records. 

  • page 

  • size 

  • bankAccountId 

  • dateFrom 

  • dateTo 


Was this article helpful?

What's Next