API get detail transaction

  • Purpose: This is the API used to get detail collection transaction.

  • API:

    • Path: v2/col/transactions/:transId

    • Method: GET

    • Request: Content-Type: application/json

Request Parameter

Parameter
Data Type
Required
Description

transId

String

Y

ID of Collection transaction returned from transaction management webhook

Response Data

Parameter
Data Type
Description

code

Number

Error code, refer to table of error codes.

message

String

Error description.

data

Object

neoResponseId

String

The ID of NeoX response.

GetDetailTransactionResponse

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

String

The amount of collection transaction.

fee

String

Collection transaction fee caculated by NeoX.

refundedAmount

String

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.

serviceInfomation

Object

debitorInformation

Object

Note

String

Note for current collection transaction.

createdAt

Datetime String (ISO 8601)

Record created time

updatedAt

Datetime String (ISO 8601)

Record last updated time

Last updated

Was this helpful?