In order to receive callbacks from our system, you need to specify 'Webhook Url' within website settings under Merchant Portal, or provide 'webhookUrl' parameter in createPayment request. In case if "webhookUrl" is passed within the payment request, it will override the static one configured in the system.
In general, we do support both static and dynamic callbacks, and you can use whatever suits your business better.
To ensure that callbacks are sent from our system, you can generate a Signing Key in your website settings. If the Signing Key is specified, callbacks from our system will include 'Signature' header with HMAC256 hash generated from JSON body and Signing Key.
| id |
string
<= 32 characters
Payment Id |
||||||||||||||||||||||||||||||||||||||||
| referenceId |
string
<= 256 characters
referenceId from payment request |
||||||||||||||||||||||||||||||||||||||||
| paymentType |
string
Payment Type |
||||||||||||||||||||||||||||||||||||||||
| state |
string
(
PaymentState
)
Enum
:
"CHECKOUT"
"PENDING"
"CANCELLED"
"DECLINED"
"COMPLETED"
Payment State |
||||||||||||||||||||||||||||||||||||||||
| description |
string
<= 512 characters
Description of the transaction |
||||||||||||||||||||||||||||||||||||||||
| parentPaymentId |
string
<= 32 characters
Initial transaction Id from payment request, usually is used to proceed with refund OR in case if card PAN needs to be used for payouts. |
||||||||||||||||||||||||||||||||||||||||
| paymentMethod |
string
(
PaymentMethod
)
Enum
:
"ACTIVE"
"ADVCASH"
"ALFABANK_P2P"
"ALIPAY"
"ALTEL"
"ALYCEPAY"
"APPLEPAY"
"APPLEPAYTOKEN"
"ASTROPAY"
"ASUPAY"
"B2BINPAY"
"BANCONTACT"
"BANKTRANSFER"
"BANK_TRANSFER_ARG"
"BANK_TRANSFER_IND"
"BANK_TRANSFER_JPY"
"BANK_TRANSFER_KRW"
"BANK_TRANSFER_PHP"
"BANK_TRANSFER_PIX"
"BANK_TRANSFER_PKR"
"BANK_TRANSFER_SEPA"
"BANK_TRANSFER_SWIFT"
"BANK_TRANSFER_TRY"
"BANK_TRANSFER_UK"
"BASIC_CARD"
"BCA"
"BEELINE"
"BILLLINE"
"BILLPLZ"
"BINANCEPAY"
"BITEXPRO"
"BITEXPRO_GOOGLEPAY"
"BITEXPRO_ADVCARD"
"BITEXPRO_ADVWALLET"
"BITEXPRO_APPLEPAY"
"BITEXPRO_BANCONTACT"
"BITEXPRO_BANKTRANSFER"
"BITEXPRO_BKASH"
"BITEXPRO_BLIK"
"BITEXPRO_BPWALLET"
"BITEXPRO_CASH,"
"BITEXPRO_CREDITCARD"
"BITEXPRO_CRYPTO"
"BITEXPRO_EUROAPM"
"BITEXPRO_EWALLET"
"BITEXPRO_EXPAY"
"BITEXPRO_GIROPAY"
"BITEXPRO_GPAY"
"BITEXPRO_HSP"
"BITEXPRO_IDEAL"
"BITEXPRO_MBWAY"
"BITEXPRO_MEEZAQR,"
"BITEXPRO_MEEZAR2P,"
"BITEXPRO_MOBILEMONEY"
"BITEXPRO_MULTIBANCO"
"BITEXPRO_NAGAD"
"BITEXPRO_NEOSURF"
"BITEXPRO_NETBANKING"
"BITEXPRO_NETELLER"
"BITEXPRO_OPENBANK"
"BITEXPRO_OPENBANKING"
"BITEXPRO_P24"
"BITEXPRO_P2P"
"BITEXPRO_PAPARA"
"BITEXPRO_PAYEER"
"BITEXPRO_PAYSAFECARD"
"BITEXPRO_PAYSAFECASH"
"BITEXPRO_PAYTM"
"BITEXPRO_PIX"
"BITEXPRO_PAYCO"
"BITEXPRO_PAYFIX"
"BITEXPRO_QRPAYMENT"
"BITEXPRO_RAPID"
"BITEXPRO_RN,"
"BITEXPRO_ROCKET"
"BITEXPRO_SBERPAY"
"BITEXPRO_SBP"
"BITEXPRO_SKRILL"
"BITEXPRO_SOFORT"
"BITEXPRO_SPEI"
"BITEXPRO_STICPAY"
"BITEXPRO_TRUSTLY"
"BITEXPRO_UPI"
"BITEXPRO_VODAFONE,"
"BITEXPRO_WALLET"
"BKASH"
"BLACK_RABBIT"
"BLIK"
"BNC"
"BNI"
"BOLETO"
"BRI"
"BSI"
"CARDSHPP"
"CARD_TO_CARD"
"CASH"
"CHEK"
"CIMB"
"CLICK"
"CLICKQR"
"COMMUNITYBANKING"
"CRYPTO"
"CRYPTO2CRYPTO"
"CRYPTO2FIAT"
"DANA"
"DANAMON"
"DEBITWAY"
"DINO"
"EFECTY"
"EFT"
"EMPAYRE"
"EPAY"
"EPS"
"EUPAGO"
"EUTELLER"
"EWALLET"
"EZPAY"
"FAWRY"
"FIAT2CRYPTO"
"FINRAX"
"FLEXEPIN"
"FPS"
"FYST"
"GATE8TRANSACT"
"GATEEXPRESS"
"GCASH"
"GIROPAY"
"GOOGLEPAY"
"GOOGLEPAYTOKEN"
"GOPAY"
"HAVALE"
"HAYHAY"
"HITES"
"HUMO"
"IBAN"
"IDEAL"
"IMPS"
"INSTANTQR"
"INTERAC"
"INTERKASSA"
"KAKAOPAY"
"KCELL"
"KESSPAY"
"KHIPU"
"KHIPUBANKTRANSFER"
"KLARNA"
"LATAM_BANKING"
"LATAM_CASH"
"LINKAJA"
"LINK_AJA"
"LOCALP2P"
"LOCALPAYMENT"
"LOCAL_BRAZIL"
"LOCAL_CHILE"
"LOCAL_MEXICO"
"LOCAL_PERU"
"LOTÉRICA"
"M10"
"M10_TO_M10"
"MACH"
"MACROPAY"
"MANDIRI"
"MAYBANK"
"MB"
"MBWAY"
"MISTERCASH"
"MOBILE"
"MOBILEMONEY"
"MOBILEMONEY_AIRTEL"
"MOBILEMONEY_BANKTRANSFER"
"MOBILEMONEY_MPESA"
"MOBILEMONEY_MTN"
"MOBILEMONEY_OPAY"
"MOBILEMONEY_ORANGE"
"MOBILEMONEY_OZOW"
"MOBILEMONEY_PALMPAY"
"MOBILEMONEY_PAYATTITUDE"
"MOBILEMONEY_SNAPSCAN"
"MOBILEMONEY_VODAFONE"
"MOBILEMONEY_WAVE"
"MOBILEMONEY_ZAMTEL"
"MONETIX"
"MONNET"
"MOOV"
"MPESA"
"MTN"
"MULTIBANCO"
"NEFT"
"NEOSURF"
"NETBANKING"
"NETELLER"
"NGENIUS"
"NUMICARD"
"NUMIPAY_HPP"
"NUMIPAY_VOUCHER"
"ONLINEBANKING"
"ONLINEBANKINGBTV"
"OPENBANKING"
"ORANGEMONEY"
"OVO"
"OXXO"
"P24"
"P2C"
"P2P"
"PAGOEFECTIVОCASH"
"PAGOEFECTIVОONLINE"
"PAGO_EFECTIVO"
"PAG_SMILE"
"PAPARA"
"PAPARAPOOL"
"PAPAZULA"
"PAYBOL"
"PAYCELL"
"PAYCO"
"PAYCOS"
"PAYFIX"
"PAYHERE"
"PAYID"
"PAYLER"
"PAYMATRIX"
"PAYMAXIS"
"PAYMAYA"
"PAYME"
"PAYMEMOBILE"
"PAYMOMENTUM"
"PAYPAL"
"PAYPORT"
"PAYRETAILERS"
"PAYRIVER"
"PAYSAFECARD"
"PAYSAFECASH"
"PAYSCROW"
"PAYTM"
"PAYU"
"PAY_BY_BANK"
"PAY_SHOP"
"PAY_U"
"PEP"
"PERFECTMONEY"
"PERMATA"
"PHONEPE"
"PICPAY"
"PID"
"PIX"
"POLI"
"POPYPARA"
"PRISMA_LINK"
"PRZELEWY24"
"PSEBANKTRANSFER"
"PSPARK"
"QBIT"
"QRCODE"
"QRIS"
"RAIFFEISEN_P2P"
"RAPIDTRANSFER"
"RAPID_TRANSFER"
"RAPYD"
"RAZORPAY"
"RETAILCARD"
"REVOLUTPAY"
"RTGS"
"SAFETYPAY"
"SAMSUNGPAY"
"SBER"
"SBERBANK_P2P"
"SBERPAY"
"SBP"
"SBP_P2P"
"SBP_TRANSFER"
"SEPA"
"SEPAP2P"
"SHOPEEPAY"
"SIRU_MOBILE"
"SKRILL"
"SLYSE"
"SMILE_PAY"
"SOFORT"
"SPEI"
"SPELL"
"SPOYNT"
"STRIPE"
"SWIFT"
"SWIPELUX"
"TELE2"
"TINK"
"TODITO"
"TPAGA"
"TRANSFER_BCA"
"TRUEMONEY"
"TRUSTLY"
"TRUSTPAYMENTS"
"TUNZER"
"UNIONPAYCARDS"
"UPI"
"UZCARD"
"VIETQR"
"VIETTELPAY"
"VIRTUALACCOUNT"
"VOLT"
"VOUCHERS"
"VOUCHSTAR"
"WEBPAY"
"WECHATWALLET"
"YOUGANDA"
"ZALO"
"ZIRAAT"
"MULTICA"
"PAGO46"
"SERVIFACIL"
"VEPUY"
"DIGITALWALLET"
"MYBANK"
"TPAY"
"TWINT"
"PAYPAY"
"WIRE"
"CARD"
"QR"
"BITEXPRO_INTERAC"
"BITEXPRO_PAYID"
"TRANSFIA"
"TOUCHNGO"
"DUITNOWQR"
"MOMO"
"MOMOB"
"RARGCARD"
"RARGBANKTRANSFER"
"RARGWALLET"
"REGPBANKTRANSFER"
"REGPWALLET"
"SMARTYPAY"
"PSE"
"PGWAY"
"JETON"
"GRABPAY"
"ACHDIRECTDEBIT"
"BACSDIRECTDEBIT"
"CASHAPPPAY"
"MOBILEPAY"
"WECHATPAY"
"WISE"
"N26"
"REVOLUT"
"BIZUM"
"UPIINTENT"
"UPINEO"
"NAGAD"
Payment Method |
||||||||||||||||||||||||||||||||||||||||
| paymentMethodDetails |
object
(
PaymentMethodDetails
)
|
||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||
| amount |
number
multiple of 1e-18
[ 1e-18 .. 999999.99 ]
Processing amount |
||||||||||||||||||||||||||||||||||||||||
| currency |
string
<
ISO 4217 code for FIAT currencies or cryptocurrency symbol
>
Processing currency |
||||||||||||||||||||||||||||||||||||||||
| customerAmount |
number
Amount from payment request. Used only in case if the request currency differs from the currency sent to the payment provider. |
||||||||||||||||||||||||||||||||||||||||
| customerCurrency |
string
<
ISO 4217 code for FIAT currencies or cryptocurrency symbol
>
Currency from payment request. Used only in case if it differs from the currency sent to the payment provider. |
||||||||||||||||||||||||||||||||||||||||
| redirectUrl |
string
<= 256 characters
URL to redirect the customer |
||||||||||||||||||||||||||||||||||||||||
| errorCode |
string
Check 'Response Codes and Messages' section for details |
||||||||||||||||||||||||||||||||||||||||
| externalResultCode |
string
Result code recieved from external provider |
||||||||||||||||||||||||||||||||||||||||
| externalRefs |
object
(
ExternalRefs
)
This field serves as an identifier linking the system's records to corresponding records in the external provider's system. |
||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||
| customer |
object
(
CustomerS2S
)
|
||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||
| billingAddress |
object
(
BillingAddress
)
Customer's billing address |
||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||
| startRecurring |
boolean
Indicates whether this payment has started a recurring flow |
||||||||||||||||||||||||||||||||||||||||
| recurringToken |
string
Token that can be used to continue the recurring flow |
||||||||||||||||||||||||||||||||||||||||
| terminalName |
string
The name of the processing terminal OR payment solution that was used to process this transaction |
||||||||||||||||||||||||||||||||||||||||
{
"id": "a0981ba1540d4062bc42d4019607sf94",
"referenceId": "payment-123",
"paymentType": "DEPOSIT",
"state": "COMPLETED or PENDING",
"description": "Funding the account",
"parentPaymentId": "a0981ba1540d4062bc42d4019607sf94",
"paymentMethod": "BASIC_CARD",
"paymentMethodDetails": {
"customerAccountNumber": "400000***0002",
"cardholderName": "Harry Potter",
"cardExpiryMonth": "07",
"cardExpiryYear": "2028",
"cardBrand": "VISA",
"cardIssuingCountry": "PL",
"cardBank": "INTL HDQTRS-CENTER OWNED"
},
"amount": 11.12,
"currency": "EUR",
"customerAmount": 15,
"customerCurrency": "USD",
"redirectUrl": "http://init/txid/a0981ba1540d4062bc42d4019607sf94",
"errorCode": "1.01",
"externalResultCode": "03",
"externalRefs": {
"orderId": 123456
},
"customer": {
"referenceId": "VIP_customer_12345",
"citizenshipCountryCode": "GB",
"firstName": "Harry",
"lastName": "Potter",
"dateOfBirth": "1996-01-05",
"email": "[email protected]",
"phone": "357 123456789",
"locale": "en",
"ip": "172.16.0.1",
"routingGroup": "VIP_Campaign",
"kycStatus": true,
"paymentInstrumentKycStatus": true,
"dateOfFirstDeposit": "2021-02-23",
"depositsAmount": 1000,
"withdrawalsAmount": 250,
"depositsCnt": 12,
"withdrawalsCnt": 3,
"trustLevel": "ftd",
"btag": true,
"affiliated": "yes"
},
"billingAddress": {
"addressLine1": "211, Victory street",
"addressLine2": "Office 7B",
"city": "Hogwarts",
"countryCode": "GB",
"postalCode": "01001",
"state": "CA"
},
"startRecurring": true,
"recurringToken": "string",
"terminalName": "string"
}