Check refund transaction

Endpoint: GET /api/v2/transaction/refund/{refundRefId}

Header Params

Params	Requirement	Data type	Description	Note
X-APPOTAPAY-AUTH	required	String	To create a JWT_TOKEN
Content-Type	required	String	Value: application/json
X-Request-ID	optional	String	Format is UUIDv4. Request ID for troubleshooting purposes	max:40
X-Language	optional	String	Value vi or en,The value corresponding to the payment link can be in Vietnamese or English (default: vi)	in:vi,en

{
    "X-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "X-Language": "vi"
}

URL params

Params	Requirement	Data type	Description
refundRefId	required	String	Refund transaction reference code

Query params

Params	Requirement	Data type	Description
type	optional	String	Type of transaction reference TRANSACTION_ID Get by transaction code on AppotaPay's side PARTNER_ORDER_ID Get by transaction code on the Partner's side Default: TRANSACTION_ID

Response

Params	Requirement	Data type	Description
refundId	required	String	Refund transaction code on AppotaPay's side
transactionId	required	String	Payment transaction code on AppotaPay's side
partnerRefId	required	String	Partner's refund transaction reference code
amount	required	Integer	The refunded amount
currency	required	String	Currency unit (accepts VND)
reason	required	String	Reason for refund
status	required	String	Refund status
createdAt	required	String	Transaction execution time
refundedAt	optional	String	Refund execution time if the refund transaction is successful

Example

Request

Response

Error

{
    "errorCode": 1,
    "message": "Invalid Params"
}

Error code table

Error code	Description
1	Missing or invalid request information
36	The transaction does not exist
401	Unauthorized