Background

Apply Refund API is applicable for initiating refunds for payment methods that support refund functionality. Currently, there are some payment methods that require special parameters according to channel requirements when initiating refund requests. See the following instructions for details.

Note

Please confirm with technical support before integration.

VNM QR

Parameter Name	Required	Parameter Description
accountNumber	M	Account number for receiving refund, supported account types: account number, card number. Merchants need to provide this information after consulting with customers.
channelCode	C	Bank code, this field is required if the refund account number type is account number. Currently this interface supports transfers to accounts of 46 Vietnamese banks. Supported bank list see Appendix

promptPay

Parameter Name	Required	Parameter Description	Remarks
phone	C	Mobile phone number	One of bank account/ID number/mobile phone number must be filled, otherwise error occurs
identificationId	C	ID number	One of bank account/ID number/mobile phone number must be filled, otherwise error occurs
accountNumber	C	Bank account number	One of bank account/ID number/mobile phone number must be filled, otherwise error occurs
channelCode	M	Bank name	Supported bank list see Appendix
customer.name	M	Name under user's bank account	/

VA

• BCA
• Mandiri
• Bank Syariah Indonesia
• DOKU VA
• BRI
• CIMB
• Permata
• BNI

Parameter Name	Required	Parameter Description	Remarks
phone	C	Mobile phone number	One of phone/email must be filled, otherwise error occurs
email	C	Email address	One of phone/email must be filled, otherwise error occurs
customer.name	M	Name under user's bank account	/

Previous pageAPM Integration Practice