跳转到主要内容
POST
/
v1
/
simulation
/
issuing
/
reversal
Simulate Reversal
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/simulation/issuing/reversal \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "transaction_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7"
}
'
{
  "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
  "card_number": "************5668",
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "transaction_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
  "transaction_type": "AUTHORIZATION",
  "card_available_balance": 2506.26,
  "authorization_code": "856268",
  "billing_amount": 70.25,
  "billing_currency": "SGD",
  "transaction_amount": 100.25,
  "transaction_currency": "USD",
  "transaction_time": "2024-03-21T17:17:32+08:00",
  "failure_reason": "1107 - Invalid CVV2",
  "transaction_status": "APPROVED",
  "posted_time": "2024-03-21T17:17:32+08:00",
  "merchant_data": {
    "category_code": "6011",
    "city": "CITY NAME",
    "country": "CN",
    "name": "ACQUIRER NAME"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts endpoint. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
必填

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

请求体

application/json
​
transaction_id
string
必填

The transaction id of the authorization you wish to reverse.

示例:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"

响应

200 - application/json

Reversal simulated successfully.

​
card_id
string
必填

Unique identifier for the card.

示例:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"

​
card_number
string
必填

Masked card number

示例:

"************5668"

​
cardholder_id
string<uuid>
必填

The cardholder’s unique identifier.

示例:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

​
transaction_id
string<uuid>
必填

Unique Identifier for transaction.

示例:

"5135e6cc-28b6-4889-81dc-3b86a09e1395"

​
transaction_type
enum<string>
必填

The type of transaction being simulated.

可用选项:
AUTHORIZATION,
REFUND,
REVERSAL
示例:

"AUTHORIZATION"

​
card_available_balance
number
必填

The card available balance.

示例:

2506.26

​
authorization_code
string
必填

Authorization Code

示例:

"856268"

​
billing_amount
number
必填

Billing amount

示例:

70.25

​
billing_currency
string
必填

Billing Currency

示例:

"SGD"

​
transaction_amount
number
必填

Transaction amount

示例:

100.25

​
transaction_currency
string
必填

Transaction currency

示例:

"USD"

​
transaction_time
string
必填

Transaction occurrence time

示例:

"2024-03-21T17:17:32+08:00"

​
failure_reason
string
必填

Reason for transaction failure.

示例:

"1107 - Invalid CVV2"

​
transaction_status
enum<string>
必填

The high-level status indicating the stage of the transaction lifecycle.

可用选项:
APPROVED,
DECLINED
示例:

"APPROVED"

​
posted_time
string

Transaction posted time

示例:

"2024-03-21T17:17:32+08:00"

​
merchant_data
object

Details about the merchant (grocery store, e-commerce website, etc.) involved in this transaction.