Changelog
Version changes of the public API documentation.
Business Collection · On-Ramp v0.1
Change type: Added
- First release. Five endpoints: quote, create order, query order, open receive account, and query receive account. Also the order Webhook. The path prefix is
/openapi/v1/collections/on-ramp.
See the On-Ramp guide.
Payment OpenAPI v1.7
Change type: Documentation clarification
- Added the character limit for
remarksin intra-bank transfers: only letters, digits, spaces, and the special characters/ - ? : ( ) . , ' +are supported.
v1.6
Change type: Added
- The fund-credit Webhook has new fields
senderBankNameandmasterAccountNo. Thesourcefield has a new valueINTERNAL, andACis removed (it was not used).
v1.5
Change type: Documentation clarification
- The fee currency is now described as the fee pricing currency.
v1.4
Change type: Documentation clarification
- Field format notes for the fund-credit Webhook:
tradeDateandvalueDateuse the original bank formatyyyyMMdd;tradeTimeusesHHmmssSSS;sourceaddsSWIFTMX.
v1.3
Change type: Compatibility enhancement
- The transfer result inquiry endpoint is more compatible with POBO payout orders. Pass
poboAccountNo. IfaccountNumberis not passed, the system matches the POBO payout account fromreferenceNoautomatically.
v1.2
Change type: Added
- The transfer endpoint response has new fields
poboAccountNoandpoboAccountName. - The transfer result inquiry endpoint has a new
accountNumberquery parameter (to specify the POBO payout account explicitly). - The
statusvalues of the intra-bank transfer response now includeSENT_TO_BANK. - Added an endpoint to inquire the estimated transfer fee.
See the Payment product guide.
Checkout B2C Payment Intent API v1.2
Change type: Changed (incompatible)
- Amounts are now decimal strings in standard units (for example,
"20.00"). The smallest currency unit is no longer used. - Times are now ISO 8601 with a time zone offset.
- Payment Intent statuses are now
AWAITING_PAYMENT/PROCESSING/PARTIALLY_PAID/PAID/COMPLETED/CANCELED. - Refund statuses and refund reasons are now uppercase code values.
- Renamed fields:
id→paymentIntentId/refundId,paymentIntent→paymentIntentId,amountReceived→receivedAmount,amountUsd→usdAmount,amountReceivedUsd→receivedUsdAmount,fee→feeAmount,succeededAt→completedAt. - Removed
object,livemode,customerWalletAddress,paidChain,paidToken, andtxHash. For payment details, seepayments[]. - Lists now use
pageNum/pageSizepagination. - The Refund create path is now
/refunds, and the detail path is now/{paymentIntentId}/refunds/{refundId}. - The create endpoints return HTTP 200.
- The Webhook payload is the same object as the query endpoint response.
See the Checkout product guide.