2025-08-14
10 days ago by marshall
Acquiring
New Payment Attempt webhook events
-
Added new Payment Attempt (PA) webhooks to improve the timeliness of payment result notifications.
-
Added Webhoooks:
acquiring.payment_attempt.created
: triggered when PA status isINITIATED
.acquiring.payment_attempt.capture_requested
: triggered when PA status isCAPTURE_REQUESTED
. Receiving this event indicates the consumer has completed the payment, and the corresponding PI transitions toSUCCESS
.acquiring.payment_attempt.cancelled
: triggered when PA status isCANCELLED
.acquiring.payment_attempt.failed
: triggered when PA status isFAILED
.- For one-to-one mapping (one PI contains only one PA): the corresponding PI can be considered failed as well (actually the PI itself transitions to
FAILED
after the system auto-close the PI). - For one-to-many mapping (one PI may include multiple PAs): the failure of one PA does not mean the PI has failed, and merchants can still initiate other PAs under the same PI.
- For one-to-one mapping (one PI contains only one PA): the corresponding PI can be considered failed as well (actually the PI itself transitions to
-
Doc link: https://docs.uqpay.com/reference/paymentattempt-result#/
Note: To receive these notifications, please subscribe to the corresponding events in your Dashboard.
New Settlements API
- Introduced a new API to query settlement detail records that have been successfully settled.
- Added Endpoints:
- Get list of settlements:
GET /api/v2/payment/settlements
- Get list of settlements:
- Feature:
- Supports optional parameters
settlement_batch_id
orpayment_intent_id
to query corresponding settlement records. - Supports pagination and time range filters.
- Returns settlement detail records with settlement_status = success.
- Refer to the Get list of settlements for full schema and examples.
- Supports optional parameters
Banking
[BREAKING]Added format restriction foraccount_number
field
- Affected Endpoints:
- Create Payout, request only
- Create Beneficiary, request only
- Changes:
- The
bank_details.account_number
field now only accepts alphanumeric characters (letters A–Z/a–z and digits 0–9). - Spaces, hyphens, and other special symbols are not allowed. If provided, the request will be rejected with a format error.
- The
- Notes:
- Applies to both
INDIVIDUAL
andCOMPANY
entity type beneficiaries.
- Applies to both
Card Issuing
Addedupdate_reason
field in Card APIs and Webhook
- Added a new field
update_reason
in both Card APIs and webhook events to indicate the reason for a card status change. - Affected Endpoints:
- List Cards, response only
- Retrieve Card, response only
- Update Card Status, response only
- Affected Webhooks:
- card.status.update.*
- Changes:
- New field
update_reason
is added to the API responses and webhook payload.
- New field
Card Recharge and Withdraw now support SHARE cards
- Affected Endpoints:
- Card Recharge, request only
- Card Withdraw, request only
- Changes:
- SHARE cards now can adjust
card_available_balance
by- Card Recharge: increasing
card_available_balance
. - Card Withdraw: decreases
card_available_balance
.
- Card Recharge: increasing
- SHARE cards now can adjust
- Notes:
- For SINGLE cards: behavior remains unchanged.