API Documentation
NeoX documents v.2
NeoX documentsNeoX documents v.2
NeoX documents v.2
NeoX documentsNeoX documents v.2
  • Introduction
  • NeoX App
    • E-Wallet
    • eKYC
    • Functionality
  • Payment Gateway
    • Payment Methods
    • Integrations
      • Hosted Checkout
        • Plugin/Extenstion
        • iOS SDK
        • Android SDK
        • React Native SDK
        • Web SDK
        • APIs
      • Direct API
        • Tokenization
      • Refund
        • APIs
        • IPN
    • Transaction Management
      • Query DR
      • Cancel
      • IPN
      • Error Codes
      • Refund on portal
    • Reconciliation
    • Settlement
  • Disbursement
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • Generate token API
      • Get merchant profile API
      • Request disbursement API
      • Get disbursement transaction API
      • Get exchange rate API
      • Inquiry bank account API
      • Currency conversion API
      • Event Notification
      • Response Data Structure
      • Error codes
    • Disbursement Account
    • Disbursement request
    • Transaction Management
      • Query Request/Transaction
      • Webhook
      • Error Codes
    • Reconciliation
  • Collections
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • API authenPlatform
      • API upload file
      • APIs for virtual accounts management
        • API create list of virtual accounts
        • API update KYC virtual account information
        • API update Virtual Account transaction data from merchant
        • API set active/inactive Virtual Account
        • API get list virtual accounts
        • API get detail virtual account
      • APIs for transactions management
        • API update transaction documents
        • API get list transactions
        • API get detail transaction
      • APIs for refund requests management
        • API create refund request
        • API get list refund requests
        • API get detail refund request
      • APIs for withdraw requests management
        • API get list withdraw banks
        • API create withdraw request
        • API get list withdraw requests
        • API get detail withdraw request
      • Event Notification
      • SFTP upload document file of collection transaction
      • Error Codes
    • Virtual Account Management
      • Virtual Account
      • Webhook
    • Transaction Management
      • Webhook
    • Transaction Status Management
      • Webhook
    • Refund Request Management
      • Webhook
    • Withdraw Request Management
      • Webhook
    • Reconciliation
    • Settlement
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page
  • Request Parameter
  • Response Data

Was this helpful?

  1. Collections
  2. Integration
  3. APIs for transactions management

API get list transactions

  • Purpose: This is the API used to get list collection transactions.

  • API:

    • Path: v2/col/transactions

    • Method: GET

    • Request: Content-Type: application/json

Request Parameter

Parameter
Data Type
Required
Description

pageIndex

Number

N

Pagination index (start from 1, default value is 1)

pageSize

Number

N

Current Page size (Default value is 20, maximum value is 500)

dateFr

Datetime String (ISO 8601)

N

Get records created from date

dateTo

Datetime String (ISO 8601)

N

Get records created to date

status

String

N

To filter transaction list by transaction status

reconcileStatus

String

N

To filter transaction list by reconcile status

payoutStatus

String

N

To filter transaction list by payout status

virtualAccountId

String

N

To filter transaction list by virtual account number

virtualAccountRequestId

String

N

To filter transaction list by ID of seller/business is provided by merchant

Response Data

Parameter
Data Type
Description

code

Number

data

Object

Return Object as follow:

message

String

Error description

neoResponseId

String

The ID of NeoX response

GetListTransactionsResponse

Parameter
Data Type
Description

merchantCode

String

Merchant Code

transId

String

The ID of transaction.

transDate

Datetime String (ISO 8601)

The date and time of transaction.

virtualAccountRequestId

String

The ID of seller/business is provided by merchant.

virtualAccountId

String

Virtual Account number.

accountName

String

Virtual Account name.

amount

Number

The amount of collection transaction.

fee

Number

Collection transaction fee caculated by NeoX.

refundedAmount

Number

Total refunded amount of collection transaction.

status

String

Transaction status.

reconcileStatus

String

Transaction reconcile status, Include: WAITING_UPLOAD: Documents for transaction were not uploaded, waiting for upload UPLOADED: Documents for transaction were uploaded, waiting for verifying APPROVED: Transaction documents were verified REJECTED: Transaction documents were verified has been rejected. RECONCILED: Transaction was reconconciled SETTLED: Transaction was settled

payoutStatus

String

Transaction payout status, Include: READY: Transaction was settled and ready for Remitout (Appear when reconcileStatus change to "SETTLED"). PROCESSING: Remitout/Payout request is processing. REJECTED: Remitout/Payout request has been rejected. SUCCESS: Remitout/Payout request has success.

createdAt

Datetime String (ISO 8601)

Record created time

updatedAt

Datetime String (ISO 8601)

Record lastest updated time

PreviousAPI update transaction documentsNextAPI get detail transaction

Last updated 5 days ago

Was this helpful?

Error code, refer to .

Ref to object.

        
{
  "totalDocs": Number, // Total records
  "totalPages": Number, // Total pages base on request pageSize
  "docs": Array of GetListTransactionsResponse
}
table of error codes
GetListTransactionsResponse