Transfer Voucher Query

Interface Information

• Path: /api/v1/txn/queryVoucher
• Method: POST
• Content-Type: application/json

Business Description

• Used to obtain electronic receipts after a successful payout transaction.
• You can query by either requestId or payoutId.
• It is recommended to save vouchers from successful transactions for reconciliation and record-keeping.

Request Parameters

Headers

Request Headers

Parameter	Value	Required	Description
Content-Type	application/json	Yes	Request body type

Request Body

Main Parameters

Parameter	Type	Description	Required
merchantNo	string	The merchant number of the request initiator.	M
onBehalfOf	string	The merchant number that the request is actually associated with. Provide this field only when initiating a request on behalf of another merchant.	N
requestId	string	Business transaction ID	C, Required if payoutId is empty
payoutId	integer	Payment transaction ID	C, Required if requestId is empty
sign	string	Signature	M

Request Example

Request

{
  "merchantNo": "800149",
  "requestId": "REQ20240115001234567890",
  "payoutId": 1234567890,
  "sign": "A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0U1V2W3X4Y5Z6"
}

Response Result

Response Headers

Parameter	Value	Required	Description
content-type	application/json;charset=UTF-8	No	Response body type

Response Parameters

Response Fields

Parameter	Type	Description
respCode	string	Response code
respMsg	string	Response message
data	object	Response data
└─merchantNo	string	Merchant number
└─requestId	string	Business transaction ID
└─payoutId	integer	Payment transaction ID
└─url	string	Voucher URL

Response Example

Response

{
  "respCode": "20000",
  "respMsg": "Success",
  "data": {
    "merchantNo": "800149",
    "requestId": "REQ20240115001234567890",
    "payoutId": 1234567890,
    "url": "https://api.onerway.com/voucher/download/abc123def456ghi789jkl012mno345pqr678stu901vwx234yz"
  }
}