API create refund request

• This is the API used to create refund request.

• API:

  • Path: v2/col/refund-requests

  • Method: POST

  • Request: Content-Type: application/json

Request Parameter

Parameter	Data Type	Required	Description
requestId	String	Y	Refund request id from merchant
collectionTransId	String	Y	ID of collection transaction being refunded.
amount	Number	Y	Refund amount.
bankSwiftCode	String	N	Refund request to bank swiftcode
bankAccountNumber	String	N	Refund request to bank account number
bankAccountName	String	N	Refund request to bank account name
bankBranch	String	N	Refund request to bank branch

Response Data

Parameter	Data Type	Description
code	Number	Error code, refer to table of error codes.
message	String	Error description.
data	Object	Refer to CreateRefundRequestResponse.
neoResponseId	String	The ID of NeoX response.

CreateRefundRequestResponse

Parameter	Data Type	Description
merchantCode	String	Merchant Code
requestId	String	The requestId when creating refund request.
collectionTransId	String	Collection's TransactionId of current refund request
approvalStatus	String	Refund request status, Include: PENDING: Refund request is waiting for approval. APPROVED: Refund request was approved. REJECTED: Refund request was rejected.
status	String	Refund transaction status, Include: SUCCESS: Refund transaction was successful FAILED: Refund transaction was failed
bankSwiftCode	String	Refund/Remitout bank swift code.
bankAccountNumber	String	Refund to bank acount number
bankAccountName	String	Refund to bank acount name.
amount	Number	Amount of refund request in VND
note	String	Note for refund request
failedReason	String	Return failed reason from banking system if refund transaction was failed
createdAt	Datetime String (ISO 8601)	Record created time