API Documentation
NeoX documents
NeoX documents
  • 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
      • Virtual Account Status
      • 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 withdraw requests management

API get list withdraw requests

  • Purpose: This is the API used to get list withdraw requests.

  • API:

    • Path: v2/col/withdraw-requests

    • 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 withdraw list by status

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

GetListWithdrawRequestsResponse

Parameter
Data Type
Description

merchantCode

String

Merchant Code

requestId

String

The requestId when creating withdraw request.

amount

Number

Amount of payout/remitout request in VND.

currency

String

(Optional) Remitout request currency.

remitedAmount

Number

(Optional) Amount of remitout request in currency.

fxRate

Number

(Optional) Foreign exchange rate for remitout request.

bankSwiftCode

String

Withdraw request to bank swiftcode.

bankAccountNumber

String

Withdraw request to bank account number.

bankAccountName

String

Withdraw request to bank account name.

status

String

Withdraw request status, include: PENDING: Withdraw request has been created and waiting for approval. APPROVED: Withdraw request has been approved. REJECTED: Withdraw request has been rejected, view note for reject reasons.

createdAt

Datetime String (ISO 8601)

Record created time

updatedAt

Datetime String (ISO 8601)

Record last updated time

PreviousAPI create withdraw requestNextAPI get detail withdraw request

Last updated 1 month ago

Was this helpful?

Error code, refer to .

Ref to object.


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