5.3 Refund

1. Overview

Use this API to initiate a refund against a successful payment. The refund can be full or partial. A transaction can have multiple refunds as long as the total refund amount is less than or equal to the original transaction amount. If the refund request is out of the refund window determined in the contract the refund request will be declined.

2. Request Info

  • Method: post

  • Path: https://prod-openapi-v2.newpay.la/beta/pay/uniRefund

2.1 Request Header

Key
Value

Content-Type

application/json

2.2 Request Data

Name
Description
Type
Required

appId

Unique identifier assigned to a third-party application platform

string

true

mchId

Unique identifier assigned to a third-party merchant

string

true

newpayOrderNo

Payment order number generated in NewPay

string

true

mchRefundNo

Refund order number in third party merchant

string

true

refundAmt

Refund amount, less or equal to the original transaction amount

string

true

callback

Refund callback URL address

string

false

sign

string

true

2.3 Response Data

Name
Description
Type

success

Success flag: true/false

boolean

message

Response message

string

code

string

timestamp

Response timestamp

long

data

Result

object

> newpayRefundNo

Refund order number in NewPay

string

> mchRefundNo

Refund order number in third-party merchant

string

> status

transaction status: SUCCESS/FAIL/PROCESSING.

string

> orderAmt

amount for the payment order

string

> refundAmt

amount for the refund order

string

> message

refund message

string

> sign

Data signature

string

Last updated