API changelog¶
2.51¶
2024-10-30
MODIFIED Modified
accountName
field inPOST /payins/{idPayin}
andPOST /payouts/{idPayout}
requests to accept also numeric characters.ADDED Added new mandatory attribute
accountName
toaccount
object inPOST /payins/{idPayin}
request and new mandatory attributeaccountName
toaccountCustomer
object inPOST /payins/{idPayin}
response andGET /payins/{idPayin}
response forMobileMoneyMethod
.
2.50¶
2024-06-03
ADDED Added new TWD currency. In detail it means:
MODIFIED Modified VA Payment payment method to be able to process TWD payments.
MODIFIED Modified
VaPayMethod
object inPOST /payins/{idPayin}
request to collectpaymentOperatorCode
as optional attribute for TWD payments.MODIFIED Modified
account
object inPOST /payins/{idPayin}
request to be optional for VA Payment payments.MODIFIED Modified
VaPayMethod
object inPOST /payins/{idPayin}
request to collectaccountName
as optional attribute for TWD payments.
ADDED Added new Payment Method Convenience Store Payment for Taiwanese market. In detail it means:
ADDED Added
CodePaymentMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
CodePaymentMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
CodePaymentMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.49¶
2024-05-22
ADDED Added new optional attribute
upiId
toPOST /payins/{idPayin}
request forUpiQRMethod
and toPOST /payins/{idPayin}
/GET /payins/{idPayin}
responses forUpiQRMethodResponse
. Identification of a UPI wallet from which customer should send the funds.
2.48¶
2024-04-19
MODIFIED Modified
MobileMoneyMethod
object inPOST /payins/{idPayin}
request to collectphoneNumber
as mandatory attribute.ADDED Added new optional attribute
accountName
toaccount
object inPOST /payins/{idPayin}
request and new optional attributeaccountName
toaccountCustomer
object inPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forCapitecPayMethod
.
2.47¶
2024-01-25
ADDED VA Payment payment method now supports payments in KRW currency.
MODIFIED Modified
VaPayMethod
object inPOST /payins/{idPayin}
request to collectpaymentOperatorCode
as optional attribute for KRW payments.MODIFIED Modified
VaPayMethodResponse
object inPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses to returnpaymentOperator
as optional object.
paymentOperator
object consists ofcode
andname
of the payment operatorADDED Added
accountCustomer
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forVaPayMethodResponse
.
accountCustomer
object consists ofaccountName
andaccountNumber
- parameters of customer’s account from which funds from customer are expected.
2.46¶
2024-01-12
ADDED Added new currencies GHS, KES and NGN. In detail it means:
MODIFIED Modified Offline Bank Transfer payment method to be able to process NGN payments.
ADDED Added new Payment Method Mobile Money for Ghanian and Kenyan market. In detail it means:
ADDED Added
MobileMoneyMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
MobileMoneyMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
MobileMoneyMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.45¶
2023-12-12
ADDED Added new Payment Method Pay Me for South African market for Capitec Bank’s customers. In detail it means:
ADDED Added
PayMeMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
PayMeMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
PayMeMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.44¶
2023-11-22
ADDED Added new optional attribute
phoneNumber
toPOST /payins/{idPayin}
request forOfflineMethod
. Phone number of your customer.ADDED Added new endpoint for checking payment details of customer’s account including data collected during a payment process of payin -
GET /payins/{idPayin}/accounts
.
2.43¶
2023-11-13
ADDED Added new optional attribute
productId
toPOST /payins/{idPayin}
request forOfflineMethod
and toGET /payins/{idPayin}
response forOfflinePayMethodResponse
. Identification of a product related to a payment order.
2.42¶
2023-10-30
MODIFIED Modified
account
object inPOST /payins/{idPayin}
request to be optional for E-Wallet payments.
2.41¶
2023-10-26
MODIFIED Modified
NetBankingMethod
object inPOST /payins/{idPayin}
request to collectaccountName
andemailAddress
as optional attributes for INR payments.
2.40¶
2023-10-18
MODIFIED Modified
account
object inPOST /payins/{idPayin}
request to be optional for Offline Bank Transfer payments.
2.39¶
2023-10-09
ADDED Added optional
externalReference
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forP2AV2MethodResponse
andUpiQRMethodResponse
externalReference
object consists ofreference
If your customer provided external reference in the payment process (passed using setExternalReference endpoint) then we return it in the response. Check Payment methods for more information about external reference.
2.38¶
2023-09-21
ADDED Added mandatory
paymentOperator
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forVaPayMethodResponse
andP2AV2MethodResponse
paymentOperator
object consists ofcode
andname
of the payment operatorADDED Added optional
paymentOperator
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forOfflineMethodResponse
paymentOperator
object consists ofcode
andname
of the payment operator
2.37¶
2023-09-19
ADDED Added new PHP currency. In detail it means:
MODIFIED Modified Offline Bank Transfer payment method to be able to process PHP payments.
ADDED Added new Payment Method QR Ph for Philippine market. In detail it means:
ADDED Added
QrPhMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
QrPhMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
QrPhMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
ADDED Added new Payment Method Capitec Pay for South African market. In detail it means:
ADDED Added
CapitecPayMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
CapitecPayMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
CapitecPayMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
ADDED Added optional
vat
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses for all payment method response objects. Amount of Value-Added Tax is returned in case it’s levied on a payment order.vat
object consists ofamount
andcurrencyCode
2.36¶
2023-07-24
ADDED Added mandatory
paymentOperator
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forCryptoOfflineMethodResponse
paymentOperator
object consists ofcode
andname
of the payment operator
2.35¶
2023-06-15
ADDED Added new LAK currency. In detail it means:
MODIFIED Modified Offline Bank Transfer payment method to be able to process LAK payments.
ADDED Added optional
paymentOperator
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forUpiQRMethodResponse
paymentOperator
object consists ofcode
andname
of the payment operator
2.34¶
2023-06-09
MODIFIED Default validity of authorization token returned by
POST /auth-tokens
was changed to 1800 seconds (30 minutes).MODIFIED Modified
PromptPayMethod
object inPOST /payins/{idPayin}
request to collectaccountNumber
as mandatory attribute for PromptPay payments.ADDED Added
accountCustomer
object toPOST /payins/{idPayin}
response forPromptPayMethodResponse
ADDED Added
accountCustomer
object toGET /payins/{idPayin}
response forPromptPayMethodResponse
accountCustomer
object consists ofaccountName
andaccountNumber
- parameters of customer’s account from which funds from customer are expected.
2.33¶
2023-04-21
ADDED Added
accountCustomer
object toPOST /payins/{idPayin}
response forDuitNowPayMethodResponse
ADDED Added
accountCustomer
object toGET /payins/{idPayin}
response forDuitNowPayMethodResponse
accountCustomer
object consists ofaccountName
andaccountNumber
- parameters of customer’s account from which funds from customer are expected.
2.32¶
2023-04-12
ADDED Added new Payment Method E-Wallet for Indonesian market. In detail it means:
ADDED Added
EWalletMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
EWalletMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
EWalletMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.31¶
2023-02-17
ADDED Added new optional fields
qrCode
andqrName
to theOfflineMethodResponse
object. Currently a QR code is supported only for payments in VND currency.ADDED Payment Method Crypto Offline now supports USDC cryptocurrency.
2.30¶
2023-01-31
ADDED Added new optional field
processorStatus
to thePaymentProcess
object.
2.29¶
2023-01-12
ADDED Added new ZAR currency. In detail it means:
MODIFIED Modified Instant Bank Transfer and Offline Bank Transfer payment methods to be able to process ZAR payments.
MODIFIED
POST /payouts/{idPayout}
request for payout in ZAR currency now requires account type -current
,savings
,cheque
ortransmission
(seepaymentMethod.account.accountType
for allowed account types).
2.28¶
2022-12-09
ADDED Added optional
upiId
attribute toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forUpiQRMethodResponse
.
2.27¶
2022-12-08
ADDED Added optional attribute
paymentOperatorCode
toPOST /payins/{idPayin}
request to payment method objectNetBanking
.ADDED Added optional
deeplink
attribute toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forNetBankingMethodResponse
.ADDED Added optional
upiId
attribute toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forNetBankingMethodResponse
.ADDED Added optional
paymentOperator
object toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forNetBankingMethodResponse
paymentOperator
object consists ofcode
andname
of the payment operator
2.26¶
2022-11-28
ADDED Added optional attribute
emailAddress
toPOST /payins/{idPayin}
request to payment method objectsCryptoOfflineMethod
,UpiIdMethod
,VietQRMethod
.MODIFIED Modified
NetBankingMethod
object inPOST /payins/{idPayin}
request to collectphoneNumber
as optional attribute for INR payments.
2.25¶
2022-10-25
ADDED Added new attribute
money
toPOST /auth-tokens
. If set, only payments with this amount and currency can be created.
2.24¶
2022-10-20
ADDED Offline Bank Transfer payment method now supports payments in THB currency.
MODIFIED Modified
OfflineMethod
object inPOST /payins/{idPayin}
request to collectaccountNumber
as mandatory attribute for THB payments.
ADDED Added new attribute
processor
toPOST /payins/{idPayin}
andGET /payins/{idPayin}
responses forOfflinePayMethodResponse
. External processor of a payment.
2.23¶
2022-10-17
ADDED Added new KRW currency. In detail it means:
MODIFIED Modified Offline Bank Transfer payment method to be able to process KRW payments.
MODIFIED Modified
OfflineMethod
object inPOST /payins/{idPayin}
request to collectaccountName
as mandatory attribute for KRW payments.
2.22¶
2022-10-10
ADDED Added new failureReasonCode
PAYMENT_OPERATOR_UNAVAILABLE
toPOST /payins/{idPayin}
/GET /payins/{idPayin}
andPOST /payouts/{idPayout}
/GET /payouts/{idPayout}
responses.MODIFIED Changed name of failureReasonCode
PAYMENT_OPERATOR_CODE_INVALID
toPAYMENT_OPERATOR_INVALID
inGET /payins/{idPayin}
andGET /payouts/{idPayout}
responses.MODIFIED Modified
OfflineMethod
object inPOST /payins/{idPayin}
request to collectaccountName
as mandatory attribute for JPY payments.
2.21¶
2022-09-13
ADDED Added new attributes to
POST /payins/{idPayin}
andPOST /payouts/{idPayout}
responses. In detail it means:ADDED Added
idPayment
attribute toPOST /payins/{idPayin}
andPOST /payouts/{idPayout}
responses. The Unique reference ID of the Order generated by platform.ADDED Added
reference
attribute toPOST /payouts/{idPayout}
response. Reference number of transaction.
MODIFIED
POST /payouts/{idPayout}
request for payouts in JPY now accepts additional account types -private
,corporate
,general
andcurrent
(seepaymentMethod.account.accountType
for supported account types).
2.20¶
2022-08-02
ADDED Added new failureReasonCodes
INCORRECT_CURRENCY
andDIFFERENT_AMOUNT_CONFIRMED
toGET /payins/{idPayin}
andGET /payouts/{idPayout}
responses.
2.19¶
2022-07-29
ADDED Added new attributes to
GET /payins/{idPayin}
andGET /payouts/{idPayout}
responses. In detail it means:ADDED Added
idPayment
attribute toGET /payins/{idPayin}
andGET /payouts/{idPayout}
responses. The Unique reference ID of the Order generated by platform.ADDED Added
reference
attribute toGET /payouts/{idPayout}
response. Reference number of transaction.
2.18¶
2022-05-30
ADDED Added new Payment Method Viet QR for Vietnamese market. In detail it means:
ADDED Added
VietQRMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
VietQRMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
VietQRMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.17¶
2022-05-02
ADDED Added new attribute upiQrDeepLink in the UPI QR payment request response.
To improve user experience of our UPI QR payment flow we introduced UPI QR deeplink which allows your customer to open UPI QR compatible payment app and initiate their payment just for one click. Instead of complicated downloading and uploading QR code on the mobile device to pay with the app your customer just open the link and his payment is ready to send.
2.16¶
2022-04-11
ADDED Added new JPY currency. In detail it means:
MODIFIED Modified Offline Bank Transfer payment method to be able to process JPY payments.
MODIFIED Modified
OfflineMethod
object toPOST /payins/{idPayin}
to collectemailAddress
as mandatory attribute for JPY payments.
2.15¶
2022-04-07
ADDED Added new Payment Method Crypto Offline for Global market. In detail it means:
ADDED Added
CryptoOfflineMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
CryptoOfflineMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
CryptoOfflineMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.14¶
2022-03-15
ADDED Added new Payment Method UPI QR for Indian market. In detail it means:
ADDED Added
UpiQRMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
UpiQRMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
UpiQRMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.13¶
2022-01-31
ADDED Added
paymentOperator
object toPOST /payins/{idPayin}
response forDuitNowPayMethodResponse
ADDED Added
paymentOperator
object toGET /payins/{idPayin}
response forDuitNowPayMethodResponse
paymentOperator
object consists ofcode
andname
of the payment operator which is used to proceed DuitNow payment.For example if your customer has chosen ShopeePay wallet (paymentOperator: {code: “MY_SHP”, name: “ShopeePay”}) in the payment process to make a payment then data are provided by the
POST /payins/{idPayin}
to our platform them we return them back in the response with payment order detail to give you complete information about the payment order data. It depends purely on you whether you process them or not.
New application¶
2021-12-07
NEW We launched our Integration DEMO Web Application which will smartly and transparently show you how easy and effective integration with us is. Go to this page and try it.
2.12¶
2021-12-15
DEPRECATED Deprecated
bankCode
,bankName
attributes inpaymentMethodResponse.P2AV2MethodResponse.account
response attribute ofPOST /payins/{idPayin}
andGET /payins/{idPayin}
.Content of these attributes is ignored now. Please do not use them, they will be removed in the future
ADDED Added new Payment Method DuitNow QR for Malaysian market. In detail it means:
ADDED Added
CryptoOfflineMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
CryptoOfflineMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
CryptoOfflineMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
ADDED Added new payment status
REFUSED
toGET /payins/{idPayin}
andGET /payouts/{idPayout}
responses
2.11¶
2021-12-01
DEPRECATED Deprecated
account
attribute inpaymentMethodResponse.OnlineMethodResponse
response attributes ofPOST /payins/{idPayin}
andGET /payins/{idPayin}
.account
attribute data are not required in the response to the ONLINE payment request since there will be always redirect to the payment operator according to data in theredirectTo
parameter.Content of these attributes is ignored now. Please do not use them, they will be removed in the future
ADDED Added optional attribute
paymentMethodResponse.OnlineMethodResponse.moneyRequired
inPOST /payins/{idPayin}
andGET /payins/{idPayin}
methods response.In some cases the payment amount is modified to be able to confirm the payment order. In such cases when
moneyRequired
is not empty we expect your customer to pay themoneyRequired
however full payment order amount is added to your account balance.ADDED Added new Payment Method DuitNow QR for Malaysian market. In detail it means:
ADDED Added
DuitNowMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
DuitNowMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
DuitNowMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
2.10¶
2021-11-05
ADDED Added
emailAddress
attribute validation to create payin endpoint request. The attribute is part of thepaymentMethod
objects where theemailAddress
attribute can or has to be provided. SeepaymentMethod
object ofPOST /payins/{idPayin}
payin endpoint request to check the validation rules.ADDED Added
phoneNumber
attribute validation to create payin endpoint request. The attribute is part of thepaymentMethod
object ofNETBANKING
payment method. SeePOST /payins/{idPayin}
NETBANKING
payment method object to check the validation rules.
2.9¶
2021-10-14
ADDED Added explicit description of 429 Http status error to affected endpoints. See this section Throttling to get more details.
2.8¶
2021-09-23
ADDED Added
paymentAddress
attribute toP2AV2MethodResponse
object inPOST /payins/{idPayin}
andGET /payins/{idPayin}
methods response. In terms of improving theP2AV2MethodResponse
object understandingpaymentAddress.name
andpaymentAddress.idAddress
now returns the data specifies payment addresses (e.g. in UPI payment system) where customer can send the payment using theirs wallets or others banking services. This data was originally returned in the attributesaccount.accountName
andaccount.accountNumber
ofP2AV2MethodResponse
object.ADDED Added
paymentInstructionList
attribute toVaPayMethodResponse
object inPOST /payins/{idPayin}
andGET /payins/{idPayin}
methods response.ADDED Added optional attribute
paymentMethodResponse.OfflineMethodResponse.moneyRequired
inPOST /payins/{idPayin}
andGET /payins/{idPayin}
methods response.In some cases the payment amount is modified to be able to confirm the payment order. In such cases when
moneyRequired
is not empty we expect your customer to pay themoneyRequired
however full payment order amount is added to your account balance.
2.7¶
2021-09-13
ADDED Added
acceptedAt
andexpireAt
attributes to all payment method response objects. (seePOST /payins/{idPayin}
andGET /payins/{idPayin}
methods response).
2.6¶
2021-09-02
ADDED
BALANCE_INSUFFICIENT
error code for 406 Not Acceptable response ofPOST /payouts/{idPayout}
2.5¶
2021-08-31
ADDED A new endpoint
GET /merchant-info
currently returns the merchant channel name that can be displayed to customer during the payment process in the Payment Web Application or your UI supporting the payment flow. The merchant channel name can be modified in your Merchant Back-office Sandbox or Live account merchant account - see Merchant Channel Name attribute in Merchant Channel Setup widget on your page.Currently, you can obtain only your channel name from your Merchant Channel Setup but soon we will add other merchant channel information parameters.
2.4¶
2021-08-24
ADDED Added new Payment Method Netbanking for Indian market. In detail it means:
ADDED Added
NetBankingMethod
object toPOST /payins/{idPayin}
(seepaymentMethod
request attribute)ADDED Added
NetBankingMethodResponse
object toPOST /payins/{idPayin}
(seepaymentMethodResponse
response attribute)ADDED Added
NetBankingMethodResponse
object toGET /payins/{idPayin}
response (seepaymentMethodResponse
response attribute)
MODIFIED
callbackUrl
attribute is now optional (seePOST /payins/{idPayin}
request andPOST /payouts/{idPayout}
request).
2.3¶
2021-08-18
ADDED Added new Payment Method QRIS (QR Code Indonesian Standard)
ADDED
QrisPayMethodQrisPayMethod
andQrisPayMethodResponse
objects inPOST /payins/{idPayin}
ADDED
QrisPayMethodResponse
object inGET /payins/{idPayin}
2.2¶
DEPRECATED Deprecated
bankBranch
,bankCity
andbankProvince
attributes inpaymentMethodResponse.P2AV2MethodResponse.account
andpaymentMethodResponse.PromptPayMethodResponse.acccount
response attributes ofPOST /payins/{idPayin}
andGET /payins/{idPayin}
.Content of these attributes is ignored now. Please do not use them, they will be removed in the future
2.1¶
DEPRECATED Deprecated
accountName
,accountNumber
,bankBranch
,bankCity
andbankProvince
attributes inpaymentMethodResponse.OnlineMethodResponse.account
response attribute ofPOST /payins/{idPayin}
andGET /payins/{idPayin}
.Content of these attributes is ignored now. Please do not use them, they will be removed in the future
2.0¶
This is the base version of our API.