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	Y	Refund request to bank swiftcode
bankAccountNumber	String	Y	Refund request to bank account number
bankAccountName	String	Y	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	ID of collection transaction being refunded.
amount	Number	Refund amount.
bankSwiftCode	String	Refund request to bank swiftcode
bankAccountNumber	String	Refund request to bank account number
bankAccountName	String	Refund request to bank account name
bankBranch	String	Refund request to bank branch
status	String	Refund request status, include: PENDING: Refund request has been created and waiting for approval. APPROVED: Refund request has been approved. REJECTED: Refund request has been rejected, view note for reject reasons.
approvalDate	Datetime String (ISO 8601)	Date of approval from NeoX. (Will be returned when refund request was approved)
createdAt	Datetime String (ISO 8601)	Record created time