JavaScript is disabled. Some features may not work. You can also read the static version: View text version

List Transactions

This api will be used to list all the transactions perfomed by a merchant-customer. For maskedAccountNumber,bankCode and umn you will need to send x-api-version: 1 in headers.

Request

Response

API Endpoints

Production Link

POST

http://{{host}}/api/{{uri}}/merchants/transactions/list

                      Content-Type
                      *
                      

String

Required

application/json

                      x-merchant-signature
                      *
                      

String

Required

This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.

                      x-merchant-id
                      *
                      

String

Required

Will be shared while onboarding.

                      x-merchant-channel-id
                      *
                      

String

Required

Will be shared while onboarding.

                      Accept
                      *
                      

String

Required

application/json

                      x-timestamp
                      *
                      

String

Required

This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.

Body

Request Schema: application/json

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer

Constraint: Alphanumeric string with dot(.). Maximum length is 256.

                      limit
                      *
                      

String

Mandatory

Maximum number of rows to be returned. Used for pagination

Constraint: Number > 0

                      offset
                      *
                      

String

Mandatory

Offset for rows to be returned. Used for pagination

Constraint: Number >= 0

                      udfParameters
                      
                      

Json String

Optional

Stringified JSON for udf parameters

Response Body

                      status
                      *
                      

String

Mandatory

PSP status of the API
Values - SUCCESS | FAILURE

                      responseMessage
                      *
                      

String

Mandatory

PSP response message for the API

                      responseCode
                      *
                      

String

Mandatory

PSP response code for the API

                      payload
                      *
                      

String

Mandatory

                      merchantChannelId
                      *
                      

String

Mandatory

Unique id for the merchant channel as passed in request headers

                      merchantId
                      *
                      

String

Mandatory

Unique id for the merchant as passed in request headers

                      merchantCustomerId
                      *
                      

String

Mandatory

Merchant generated unique profile id for customer as passed in the request

                      txnList
                      *
                      

Array of Json

Mandatory

List of all transactions performed by the user

                      amount
                      *
                      

String

Mandatory

Transactions amount

                      maskedAccountNumber
                      *
                      

String

Mandatory

Masked acc. number of the user

                      payeeName
                      *
                      

String

Mandatory

Name of Payee

                      refUrl
                      *
                      

String

Mandatory

Invoice as sent by merchant or reference to the transaction in the form of url.

                      payeeMcc
                      
                      

String

Optional

Merchant Category Code of the payee merchant.
Constraint - String of 4 digits. “0000” for non-merchant

                      gatewayResponseMessage
                      *
                      

String

Mandatory

Response message returned by gateway for the transaction.

                      payerVpa
                      *
                      

String

Mandatory

Vpa of Payer

                      payerName
                      *
                      

String

Mandatory

Name of Payer

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated id for the transaction

                      gatewayResponseCode
                      *
                      

String

Mandatory

Response code returned by gateway for transaction

                      gatewayReferenceId
                      *
                      

String

Mandatory

UpiResponseId as passed in request or transaction

                      isP2MTransaction
                      *
                      

Boolean

Mandatory

Was the transaction of type=P2M

                      gatewayTransactionId
                      *
                      

String

Mandatory

upiRequestId as passed in request of transaction

                      payerMobileNumber
                      *
                      

String

Mandatory

Mobile number of the customer who made the payment
Constraint - String of 12 digits.

                      payeeVpa
                      *
                      

String

Mandatory

Vpa of Payee

                      transactionTimestamp
                      *
                      

String

Mandatory

Timestamp of when the transaction was attempted
Format - YYYY-MM-DDTHH:MM:SS+05:30

                      type
                      *
                      

String

Mandatory

Type of the transaction
Values - PAY | COLLECT

                      bankCode
                      *
                      

String

Mandatory

6-digit number

                      selfInitiated
                      *
                      

Boolean String

Mandatory

Was the transaction initiated by the merchantCustomer

                      remarks
                      *
                      

String

Mandatory

Any transaction summary
Constraint - 50 characters, alphanumeric, space and hyphen

                      udfParameters
                      
                      

Json String

Optional

Udf parameters as passed in the request

Have questions?
Need help? Contact support
LLM? Read llms.txt