API changelog¶
2.72¶
2025-10-17
MODIFIED Modified
AbsaPayMethodobject inPOST /payins/{idPayin}request to collectaccount.accountNumberas optional attribute.ADDED Added new mandatory attribute
account.accountNametoPOST /payins/{idPayin}request forAbsaPayMethod. Account name of a customerMODIFIED Modified
AbsaPayMethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}responses to returnaccount.accountNumberas optional attribute.ADDED Added new optional attribute
accountCustomer.accountNametoPOST /payins/{idPayin}andGET /payins/{idPayin}responses forAbsaPayMethodResponse. Account name of a customerMODIFIED Modified
PayShapMethodobject inPOST /payins/{idPayin}request to collectaccount.accountNumberas optional attribute.MODIFIED Modified
PayShapMethodobject inPOST /payins/{idPayin}request to collectaccount.accountNameas optional attribute.ADDED Added new mandatory attribute
account.accountNametoPOST /payins/{idPayin}request forPayShapMethod. Account name of a customer
2.71¶
2025-10-07
MODIFIED Modified
WalletTransferMethodobject inPOST /payouts/{idPayout}request to collectemailAddressas optional attribute.MODIFIED Modified
PayShapMethodobject inPOST /payins/{idPayin}request to collectaccount.accountNumberas mandatory attribute.ADDED Added new mandatory attribute
account.accountNametoPOST /payins/{idPayin}request forPayShapMethod. Account name of a customer
2.70¶
2025-09-24
ADDED Added new attribute
processortoPOST /payins/{idPayin}andGET /payins/{idPayin}responses forVaPayMethodResponse. External processor of a payment.
2.69¶
2025-09-22
MODIFIED Modified
CapitecPayMethodobject inPOST /payins/{idPayin}request to collectaccount.accountNumberas optional attribute for Capitec Pay payments in ZAR currency.MODIFIED Modified
CapitecPayMethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}responses to returnaccount.accountNumberas optional attribute for Capitec Pay payments in ZAR currency.
2.68¶
2025-09-04
ADDED Added new Payment Method PSE for Colombian market. In detail it means:
ADDED Added
PseMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
PseMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
PseMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.67¶
2025-08-27
ADDED Added new optional attribute
emailAddresstoPOST /payins/{idPayin}/GET /payins/{idPayin}responses forOfflineMethodResponseandMobileMoneyMethodResponse. Customer’s email address.ADDED Added new optional attribute
paymentOperatorCodetoPOST /payins/{idPayin}request forMobileMoneyMethodand new optional objectpaymentOperatortoPOST /payins/{idPayin}/GET /payins/{idPayin}responses forMobileMoneyMethodResponse.
paymentOperator object consists of code and name of the payment operator
2.66¶
2025-08-04
ADDED Added mandatory attribute
phoneNumberinPOST /payins/{idPayin}request forCodePaymentMethodand inPOST /payins/{idPayin}/GET /payins/{idPayin}responses forCodePaymentMethodResponse.ADDED Added mandatory attribute
emailAddressinPOST /payins/{idPayin}/GET /payins/{idPayin}responses forCodePaymentMethodResponse.ADDED Added mandatory
paymentLocationobject toPOST /payins/{idPayin}request forCodePaymentMethodand mandatorypaymentLocationCustomerobject toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forCodePaymentMethodResponse.paymentLocation/paymentLocationCustomerobjects contain data about location where customer is making a paymentADDED Added optional
paymentLocationobject toPOST /payins/{idPayin}request forVaPayMethodand toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forVaPayMethodResponse.paymentLocation/paymentLocationCustomerobjects contain data about location where customer is making a paymentMODIFIED Modified
VaPayMethodobject inPOST /payins/{idPayin}request to collectemailAddressandphoneNumberas mandatory attributes for VA payments in TWD currency.ADDED Added optional attribute
emailAddressinPOST /payins/{idPayin}/GET /payins/{idPayin}responses forVaPayMethodResponse.ADDED Added new COP currency. In detail it means:
MODIFIED Modified
BankTransferMethodobject inPOST /payouts/{idPayout}request to collectidentifyingReferenceas mandatory field for COP payments (see description ofBankTransferMethodfor allowed identifying references in ARS).MODIFIED Modified
BankTransferMethodobject inPOST /payouts/{idPayout}request to collectaccount.accountTypeas mandatory field for COP payments (seepaymentMethod.account.accountTypefor allowed account types).MODIFIED Modified
BankTransferMethodobject inPOST /payouts/{idPayout}request to collectphoneNumberas mandatory field for COP payments.
ADDED Added new ARS currency. In detail it means:
MODIFIED Modified
BankTransferMethodobject inPOST /payouts/{idPayout}request to collectidentifyingReferenceas mandatory field for ARS payments (see description ofBankTransferMethodfor allowed identifying references in ARS).MODIFIED Modified
OfflineMethodobject inPOST /payins/{idPayin}request to collecttaxIdas mandatory attribute for ARS payments.MODIFIED Modified
OfflineMethodResponseobject inPOST /payins/{idPayin}response to return optional fieldtaxId.MODIFIED Modified
BankTransferMethodobject inPOST /payins/{idPayin}request to collectpaymentOperatorCodeas optional field for ARS payments.
ADDED Added new MXN currency. In detail it means:
MODIFIED Modified
BankTransferMethodobject inPOST /payins/{idPayin}request to collectaccount.accountTypeas mandatory field for MXN payments (seepaymentMethod.account.accountTypefor allowed account types).
2.65¶
2025-07-31
ADDED Added new optional attribute
passportNumbertoPOST /payins/{idPayin}request forAbsaPayMethodand toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forAbsaPayMethodResponse. Customer’s passport number.ADDED Added new optional attribute
saidtoPOST /payins/{idPayin}request forAbsaPayMethodand toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forAbsaPayMethodResponse. Customer’s South African ID number.ADDED Added new optional object
customerwith optional fieldidCustomertoGET /topup-optionsresponse. Contains ID of customer given by merchant.ADDED Added optional
accountCustomerUsedForPaymentobject toGET /payins/{idPayin}response forAbsaPayMethodResponse.accountCustomerUsedForPaymentobject contains data about account used by the customer for the payment
2.64¶
2025-06-02
ADDED Added new optional attribute
phoneNumbertoPOST /payins/{idPayin}request forVaPayMethodand toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forVaPayMethodResponse. Phone number of a customer.ADDED Added new optional attribute
phoneNumbertoPOST /payins/{idPayin}/GET /payins/{idPayin}responses forOfflineMethodResponse. Phone number of a customer.MODIFIED
POST /payouts/{idPayout}request for payouts in JPY now accepts additional account types -private,corporate,generalandcurrent(seepaymentMethod.account.accountTypefor supported account types).ADDED Added new payment methods for outgoing payments. In detail it means:
ADDED Added
EmailTransferMethod,PhoneNumberTransferMethod,RandomKeyTransferMethodandTaxPayerIdTransferMethodobjects toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
EmailTransferMethodResponse,PhoneNumberTransferMethodResponse,RandomKeyTransferMethodResponseandTaxPayerIdTransferMethodResponseobjects toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
EmailTransferMethodResponse,PhoneNumberTransferMethodResponse,RandomKeyTransferMethodResponseandTaxPayerIdTransferMethodResponseobjects toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
ADDED Added new Payment Method FPX for Malaysian market. In detail it means:
ADDED Added
FpxMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
FpxMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
FpxMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.63¶
2025-05-15
ADDED Added optional
accountCustomerUsedForPaymentobject toGET /payins/{idPayin}response forCapitecPayMethodResponseandUpiQRMethodResponse.accountCustomerUsedForPaymentobject contains data about account used by the customer for the payment
2.62¶
2025-04-25
ADDED Added new BRL currency. In detail it means:
ADDED Added new Payment Method Pix for Brazilian market. In detail it means:
ADDED Added
PixQRMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
PixQRMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
PixQRMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.61¶
2025-04-11
MODIFIED Modified
CodePaymentMethodobject inPOST /payins/{idPayin}request to collectemailas mandatory attribute.
2.60¶
2025-03-31
ADDED Added optional
accountCustomerUsedForPaymentobject toGET /payins/{idPayin}response forOnlineMethodResponseandQrisPayMethodResponse.accountCustomerUsedForPaymentobject contains data about account used by the customer for the paymentADDED
POST /auth-tokensandPOST /auth-tokens-by-actionnow support token generation using private / public key pair. Refer to Asymmetric signature section for more details.ADDED Added new 406 Not Acceptable error code to
POST /payins/{idPayin}response -CUSTOMER_ACCOUNT_LIMIT_EXCEEDED.ADDED Added new error code
CUSTOMER_ACCOUNT_LIMIT_EXCEEDEDin failureReasonCode field inGET /payins/{idPayin}response.
2.59¶
2025-03-14
ADDED
qrCodeinOfflineMethodResponseobject is now returned also for payments in LAK currency.ADDED Added new optional attribute
accountNumbertoaccountCustomerobject inPOST /payins/{idPayin}response andGET /payins/{idPayin}response forOfflineMethodResponse.MODIFIED Modified
CodePaymentMethodobject inPOST /payins/{idPayin}request to collectaccountNameas mandatory attribute.MODIFIED Modified
CodePaymentMethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}responses to returnaccountNameas mandatory attribute.
2.58¶
2025-02-27
ADDED Added new NAD currency. In detail it means:
MODIFIED Modified Instant Bank Transfer and Offline Bank Transfer payment methods to be able to process NAD payments.
2.57¶
2025-02-17
ADDED Added new optional attribute
processortoPOST /payins/{idPayin}andGET /payins/{idPayin}responses forUpiQRMethodResponse. External processor of a payment.
2.56¶
2025-01-29
MODIFIED Modified
WalletTransferMethodobject inPOST /payouts/{idPayout}request to collectphoneNumberandaccount.accountNameas mandatory attributes for GHS and KES payments.ADDED Added new Payment Method PayShap for South African market. In detail it means:
ADDED Added
PayShapMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
PayShapMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
PayShapMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)ADDED Added optional object
externalProviderstoPOST /payins/!availablePaymentOptionsresponse.externalProvidersobject contains list of providers wherecodeandnameis defined for each provider.
2.55¶
2025-01-15
MODIFIED Changed allowed values of
paymentTypeCodefield in response ofGET /topup-optionstoTOPUP_WALLET
2.54¶
2024-12-06
ADDED Added new 406 Not Acceptable error codes to
POST /payins/{idPayin}response -ACCOUNT_TYPE_INELIGIBLEandINVALID_ACCOUNT_NUMBER.ADDED Added new error codes
CUSTOMER_VERIFICATION_REJECTED,CUSTOMER_VERIFICATION_FAILEDandACCOUNT_TYPE_INELIGIBLEin failureReasonCode field inGET /payins/{idPayin}response.ADDED Added new endpoint
GET /settlement-payment-optionswhich returns payment options (see payment option) enabled for merchant’s settlements.
2.53¶
2024-11-26
ADDED Added new Payment Method Absa Pay for South African market. In detail it means:
ADDED Added
AbsaPayMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
AbsaPayMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
AbsaPayMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.52¶
2024-11-19
ADDED Added new optional attribute
phoneNumbertoPOST /payins/{idPayin}request forUpiQRMethodand toPOST /payins/{idPayin}/GET /payins/{idPayin}responses forUpiQRMethodResponse. Phone number of a customer.ADDED Added new optional attribute
accountNametoaccountobject inPOST /payins/{idPayin}request and new optional attributeaccountNametoaccountCustomerobject inPOST /payins/{idPayin}andGET /payins/{idPayin}responses forUpiQRMethod.
2.51¶
2024-10-30
ADDED Added new FX rates related requests for getting a list of supported currency pairs and a list of FX rates.
ADDED Added
GET /fx-ratesrequest to collect a list of currency pairs for which our system usually contains valid FX rates.ADDED Added
GET /fx-rate-pairsrequest to collect a list of currently valid FX rates.
MODIFIED Modified
accountNamefield inPOST /payins/{idPayin}andPOST /payouts/{idPayout}requests to accept also numeric characters.ADDED Added new mandatory attribute
accountNametoaccountobject inPOST /payins/{idPayin}request and new mandatory attributeaccountNametoaccountCustomerobject 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
VaPayMethodobject inPOST /payins/{idPayin}request to collectpaymentOperatorCodeas optional attribute for TWD payments.MODIFIED Modified
accountobject inPOST /payins/{idPayin}request to be optional for VA Payment payments.MODIFIED Modified
VaPayMethodobject inPOST /payins/{idPayin}request to collectaccountNameas optional attribute for TWD payments.
ADDED Added new Payment Method Convenience Store Payment for Taiwanese market. In detail it means:
ADDED Added
CodePaymentMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
CodePaymentMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
CodePaymentMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.49¶
2024-05-22
ADDED Added new optional attribute
upiIdtoPOST /payins/{idPayin}request forUpiQRMethodand 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
MobileMoneyMethodobject inPOST /payins/{idPayin}request to collectphoneNumberas mandatory attribute.ADDED Added new optional attribute
accountNametoaccountobject inPOST /payins/{idPayin}request and new optional attributeaccountNametoaccountCustomerobject 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
VaPayMethodobject inPOST /payins/{idPayin}request to collectpaymentOperatorCodeas optional attribute for KRW payments.MODIFIED Modified
VaPayMethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}responses to returnpaymentOperatoras optional object.
paymentOperatorobject consists ofcodeandnameof the payment operatorADDED Added
accountCustomerobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forVaPayMethodResponse.
accountCustomerobject consists ofaccountNameandaccountNumber- 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
MobileMoneyMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
MobileMoneyMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
MobileMoneyMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse 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
PayMeMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
PayMeMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
PayMeMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.44¶
2023-11-22
ADDED Added new optional attribute
phoneNumbertoPOST /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
productIdtoPOST /payins/{idPayin}request forOfflineMethodand toGET /payins/{idPayin}response forOfflinePayMethodResponse. Identification of a product related to a payment order.
2.42¶
2023-10-30
MODIFIED Modified
accountobject inPOST /payins/{idPayin}request to be optional for E-Wallet payments.
2.41¶
2023-10-26
MODIFIED Modified
NetBankingMethodobject inPOST /payins/{idPayin}request to collectaccountNameandemailAddressas optional attributes for INR payments.
2.40¶
2023-10-18
MODIFIED Modified
accountobject inPOST /payins/{idPayin}request to be optional for Offline Bank Transfer payments.
2.39¶
2023-10-09
ADDED Added optional
externalReferenceobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forP2AV2MethodResponseandUpiQRMethodResponseexternalReferenceobject consists ofreferenceIf 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
paymentOperatorobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forVaPayMethodResponseandP2AV2MethodResponsepaymentOperatorobject consists ofcodeandnameof the payment operatorADDED Added optional
paymentOperatorobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forOfflineMethodResponsepaymentOperatorobject consists ofcodeandnameof 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
QrPhMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
QrPhMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
QrPhMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
ADDED Added new Payment Method Capitec Pay for South African market. In detail it means:
ADDED Added
CapitecPayMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
CapitecPayMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
CapitecPayMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
ADDED Added optional
vatobject 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.vatobject consists ofamountandcurrencyCode
2.36¶
2023-07-24
ADDED Added mandatory
paymentOperatorobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forCryptoOfflineMethodResponsepaymentOperatorobject consists ofcodeandnameof 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
paymentOperatorobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forUpiQRMethodResponsepaymentOperatorobject consists ofcodeandnameof the payment operator
2.34¶
2023-06-09
MODIFIED Default validity of authorization token returned by
POST /auth-tokenswas changed to 1800 seconds (30 minutes).MODIFIED Modified
PromptPayMethodobject inPOST /payins/{idPayin}request to collectaccountNumberas mandatory attribute for PromptPay payments.ADDED Added
accountCustomerobject toPOST /payins/{idPayin}response forPromptPayMethodResponseADDED Added
accountCustomerobject toGET /payins/{idPayin}response forPromptPayMethodResponseaccountCustomerobject consists ofaccountNameandaccountNumber- parameters of customer’s account from which funds from customer are expected.
2.33¶
2023-04-21
ADDED Added
accountCustomerobject toPOST /payins/{idPayin}response forDuitNowPayMethodResponseADDED Added
accountCustomerobject toGET /payins/{idPayin}response forDuitNowPayMethodResponseaccountCustomerobject consists ofaccountNameandaccountNumber- 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
EWalletMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
EWalletMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
EWalletMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.31¶
2023-02-17
ADDED Added new optional fields
qrCodeandqrNameto theOfflineMethodResponseobject. 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
processorStatusto thePaymentProcessobject.
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,chequeortransmission(seepaymentMethod.account.accountTypefor allowed account types).
2.28¶
2022-12-09
ADDED Added optional
upiIdattribute toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forUpiQRMethodResponse.
2.27¶
2022-12-08
ADDED Added optional attribute
paymentOperatorCodetoPOST /payins/{idPayin}request to payment method objectNetBanking.ADDED Added optional
deeplinkattribute toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forNetBankingMethodResponse.ADDED Added optional
upiIdattribute toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forNetBankingMethodResponse.ADDED Added optional
paymentOperatorobject toPOST /payins/{idPayin}andGET /payins/{idPayin}responses forNetBankingMethodResponsepaymentOperatorobject consists ofcodeandnameof the payment operator
2.26¶
2022-11-28
ADDED Added optional attribute
emailAddresstoPOST /payins/{idPayin}request to payment method objectsCryptoOfflineMethod,UpiIdMethod,VietQRMethod.MODIFIED Modified
NetBankingMethodobject inPOST /payins/{idPayin}request to collectphoneNumberas optional attribute for INR payments.
2.25¶
2022-10-25
ADDED Added new attribute
moneytoPOST /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
OfflineMethodobject inPOST /payins/{idPayin}request to collectaccountNumberas mandatory attribute for THB payments.
ADDED Added new attribute
processortoPOST /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
OfflineMethodobject inPOST /payins/{idPayin}request to collectaccountNameas mandatory attribute for KRW payments.
2.22¶
2022-10-10
ADDED Added new failureReasonCode
PAYMENT_OPERATOR_UNAVAILABLEtoPOST /payins/{idPayin}/GET /payins/{idPayin}andPOST /payouts/{idPayout}/GET /payouts/{idPayout}responses.MODIFIED Changed name of failureReasonCode
PAYMENT_OPERATOR_CODE_INVALIDtoPAYMENT_OPERATOR_INVALIDinGET /payins/{idPayin}andGET /payouts/{idPayout}responses.MODIFIED Modified
OfflineMethodobject inPOST /payins/{idPayin}request to collectaccountNameas 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
idPaymentattribute toPOST /payins/{idPayin}andPOST /payouts/{idPayout}responses. The Unique reference ID of the Order generated by platform.ADDED Added
referenceattribute toPOST /payouts/{idPayout}response. Reference number of transaction.
MODIFIED
POST /payouts/{idPayout}request for payouts in JPY now accepts additional account types -private,corporate,generalandcurrent(seepaymentMethod.account.accountTypefor supported account types).
2.20¶
2022-08-02
ADDED Added new failureReasonCodes
INCORRECT_CURRENCYandDIFFERENT_AMOUNT_CONFIRMEDtoGET /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
idPaymentattribute toGET /payins/{idPayin}andGET /payouts/{idPayout}responses. The Unique reference ID of the Order generated by platform.ADDED Added
referenceattribute 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
VietQRMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
VietQRMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
VietQRMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse 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
OfflineMethodobject toPOST /payins/{idPayin}to collectemailAddressas 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
CryptoOfflineMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
CryptoOfflineMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
CryptoOfflineMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.14¶
2022-03-15
ADDED Added new Payment Method UPI QR for Indian market. In detail it means:
ADDED Added
UpiQRMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
UpiQRMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
UpiQRMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.13¶
2022-01-31
ADDED Added
paymentOperatorobject toPOST /payins/{idPayin}response forDuitNowPayMethodResponseADDED Added
paymentOperatorobject toGET /payins/{idPayin}response forDuitNowPayMethodResponsepaymentOperatorobject consists ofcodeandnameof 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,bankNameattributes inpaymentMethodResponse.P2AV2MethodResponse.accountresponse 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
CryptoOfflineMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
CryptoOfflineMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
CryptoOfflineMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
ADDED Added new payment status
REFUSEDtoGET /payins/{idPayin}andGET /payouts/{idPayout}responses
2.11¶
2021-12-01
DEPRECATED Deprecated
accountattribute inpaymentMethodResponse.OnlineMethodResponseresponse attributes ofPOST /payins/{idPayin}andGET /payins/{idPayin}.accountattribute 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 theredirectToparameter.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.moneyRequiredinPOST /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
moneyRequiredis not empty we expect your customer to pay themoneyRequiredhowever 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
DuitNowMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
DuitNowMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
DuitNowMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
2.10¶
2021-11-05
ADDED Added
emailAddressattribute validation to create payin endpoint request. The attribute is part of thepaymentMethodobjects where theemailAddressattribute can or has to be provided. SeepaymentMethodobject ofPOST /payins/{idPayin}payin endpoint request to check the validation rules.ADDED Added
phoneNumberattribute validation to create payin endpoint request. The attribute is part of thepaymentMethodobject ofNETBANKINGpayment method. SeePOST /payins/{idPayin}NETBANKINGpayment 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
paymentAddressattribute toP2AV2MethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}methods response. In terms of improving theP2AV2MethodResponseobject understandingpaymentAddress.nameandpaymentAddress.idAddressnow 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.accountNameandaccount.accountNumberofP2AV2MethodResponseobject.ADDED Added
paymentInstructionListattribute toVaPayMethodResponseobject inPOST /payins/{idPayin}andGET /payins/{idPayin}methods response.ADDED Added optional attribute
paymentMethodResponse.OfflineMethodResponse.moneyRequiredinPOST /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
moneyRequiredis not empty we expect your customer to pay themoneyRequiredhowever full payment order amount is added to your account balance.
2.7¶
2021-09-13
ADDED Added
acceptedAtandexpireAtattributes to all payment method response objects. (seePOST /payins/{idPayin}andGET /payins/{idPayin}methods response).
2.6¶
2021-09-02
ADDED
BALANCE_INSUFFICIENTerror code for 406 Not Acceptable response ofPOST /payouts/{idPayout}
2.5¶
2021-08-31
ADDED A new endpoint
GET /merchant-infocurrently 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
NetBankingMethodobject toPOST /payins/{idPayin}(seepaymentMethodrequest attribute)ADDED Added
NetBankingMethodResponseobject toPOST /payins/{idPayin}(seepaymentMethodResponseresponse attribute)ADDED Added
NetBankingMethodResponseobject toGET /payins/{idPayin}response (seepaymentMethodResponseresponse attribute)
MODIFIED
callbackUrlattribute 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
QrisPayMethodQrisPayMethodandQrisPayMethodResponseobjects inPOST /payins/{idPayin}ADDED
QrisPayMethodResponseobject inGET /payins/{idPayin}
2.2¶
DEPRECATED Deprecated
bankBranch,bankCityandbankProvinceattributes inpaymentMethodResponse.P2AV2MethodResponse.accountandpaymentMethodResponse.PromptPayMethodResponse.acccountresponse 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,bankCityandbankProvinceattributes inpaymentMethodResponse.OnlineMethodResponse.accountresponse 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.