Download OpenAPI specification:Download
PayAdmit API Specification
Here you will find API Specifications, Request/Response Samples, Sandbox Details for all available endpoints and flows, to help you quickly and efficiently integrate our payment solution.
Get a list of payments sorted by creation date (most recent first)
offset | integer [ 0 .. 1000000 ] The number of items to skip before starting to collect the result set. Default is 0. |
limit | integer [ 1 .. 1000 ] The numbers of items to return. Default is 50. |
created.gte | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.gte=2022-11-10T12:12:21 If passed, return only payments created at or after the specified time |
created.lt | string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)> Example: created.lt=2022-11-10T12:12:21 If passed, return only payments created strictly before the specified time |
{- "timestamp": "2022-10-05T11:23:12.595+00:00",
- "status": 200,
- "hasMore": true,
- "result": [
- {
- "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"
}, - "amount": 11.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "startRecurring": true,
- "recurringToken": "string",
- "terminalName": "string"
}
]
}
Payment request, used for DEPOSITS
Payment Request - Request to initiate a transaction.
The parameters are different in HPP and S2S integration.
In order to specify the correct parameters when building a query, you can choose the appropriate schema, which is described below.
referenceId | string <= 256 characters Reference assigned by Merchant (referenceId is used ONLY internally and not sent to the payment provider OR acquiring bank) Will be sent unchanged within the PaymentResponse. |
paymentType required | string (PaymentType) Enum: "DEPOSIT" "WITHDRAWAL" "REFUND" "CARDVERIFY" Payment Type |
paymentMethod | string (PaymentMethod) Enum: "ADVCASH" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ASTROPAY" "B2BINPAY" "BANKTRANSFER" "BASIC_CARD" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_HSP" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_PAYEER" "BITEXPRO_P2P" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_STICPAY" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "IBAN" "IDEAL" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MB" "MBWAY" "MISTERCASH" "MOBILE" "MOBILEMONEY" "MOBILEMONEY_AIRTEL" "MOBILEMONEY_BANKTRANSFER" "MOBILEMONEY_MPESA" "MOBILEMONEY_MTN" "MOBILEMONEY_ORANGE" "MOBILEMONEY_OZOW" "MOBILEMONEY_SNAPSCAN" "MOBILEMONEY_VODAFONE" "MOBILEMONEY_WAVE" "MOBILEMONEY_ZAMTEL" "MONETIX" "MONNET" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "PAGO_EFECTIVO" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYTM" "PEP" "PERFECTMONEY" "PICPAY" "PIX" "POLI" "PRZELEWY24" "PSEBANKTRANSFER" "QRCODE" "RAPID_TRANSFER" "RAPIDTRANSFER" "RAPYD" "RETAILCARD" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "WEBPAY" "WECHATWALLET" "ZALO" "MANDIRI" "REVOLUTPAY" "PAYSCROW" "PID" Payment Method |
amount required | number multiple of 1e-18 [ 1e-18 .. 999999.99 ] Payment amount |
currency required | string <ISO 4217 code for FIAT currencies or cryptocurrency symbol> Payment currency |
description | string <= 512 characters Description of the transaction shown to the Customer. Can be sent outside of the system, to the payment provider or acquiring bank. |
object (Card) You must be PCI DSS compliant to collect card data on your side. If you are not certified, do not add this field to your request and we will collect the data on our Payment page. In case if you prefer working using s2s mode, make sure you've provided us with your latest PCI DSS certificate and AoC. | |
object (CustomerS2S) | |
object (BillingAddress) Customer's billing address | |
returnUrl | string <= 256 characters URL to redirect the Customer after TX processing |
pendingReturnUrl | string <= 256 characters URL to redirect the Customer during TX processing. Overrides static value from Shop. |
successReturnUrl | string <= 256 characters URL to redirect the Customer after TX processing in case of success |
declineReturnUrl | string <= 256 characters URL to redirect the Customer after TX processing in case of decline |
webhookUrl | string Url to receive payment status notifications (callbacks) |
startRecurring | boolean Send 'true' if you want this payment to initiate recurring flow. Default value is 'false'. |
recurringToken | string To continue recurring flow, send a token from a previously initiated recurring payment. |
cardPanId | number Proceeding with payment, using verified and tokenized card. |
object Additional parameters may be required by some payment providers or banks. Contact our Support or your personal Account Manager for more details. |
{- "referenceId": "payment_id=45768;custom_ref=123",
- "paymentType": "DEPOSIT",
- "paymentMethod": "BASIC_CARD",
- "amount": 11.12,
- "currency": "EUR",
- "description": "Funding the account number 12345",
- "card": {
- "cardNumber": "4000 0000 0000 0002",
- "cardholderName": "Harry Potter",
- "cardSecurityCode": "130",
- "expiryMonth": "07",
- "expiryYear": "2028"
}, - "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "startRecurring": true,
- "recurringToken": "string",
- "cardPanId": 0,
- "additionalParameters": {
- "bankCode": "ABCD1234567",
- "countryOfBirth": "GB"
}
}
{- "timestamp": "2022-11-06T10:16:11.595+00:00",
- "status": 200,
- "result": {
- "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"
}, - "amount": 11.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "startRecurring": true,
- "recurringToken": "string",
- "terminalName": "string"
}
}
Payment request, used for WITHDRAWALS
Payout Request - Request to initiate a transaction.
referenceId | string <= 256 characters Reference assigned by Merchant (referenceId is used ONLY internally and not sent to the payment provider OR acquiring bank) Will be sent unchanged within the PaymentResponse. |
paymentType required | string Payment Type |
paymentMethod | string (PaymentMethod) Enum: "ADVCASH" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ASTROPAY" "B2BINPAY" "BANKTRANSFER" "BASIC_CARD" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_HSP" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_PAYEER" "BITEXPRO_P2P" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_STICPAY" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "IBAN" "IDEAL" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MB" "MBWAY" "MISTERCASH" "MOBILE" "MOBILEMONEY" "MOBILEMONEY_AIRTEL" "MOBILEMONEY_BANKTRANSFER" "MOBILEMONEY_MPESA" "MOBILEMONEY_MTN" "MOBILEMONEY_ORANGE" "MOBILEMONEY_OZOW" "MOBILEMONEY_SNAPSCAN" "MOBILEMONEY_VODAFONE" "MOBILEMONEY_WAVE" "MOBILEMONEY_ZAMTEL" "MONETIX" "MONNET" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "PAGO_EFECTIVO" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYTM" "PEP" "PERFECTMONEY" "PICPAY" "PIX" "POLI" "PRZELEWY24" "PSEBANKTRANSFER" "QRCODE" "RAPID_TRANSFER" "RAPIDTRANSFER" "RAPYD" "RETAILCARD" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "WEBPAY" "WECHATWALLET" "ZALO" "MANDIRI" "REVOLUTPAY" "PAYSCROW" "PID" Payment Method |
amount required | number multiple of 1e-18 [ 1e-18 .. 999999.99 ] Payment amount |
currency required | string <ISO 4217 code for FIAT currencies or cryptocurrency symbol> Payment currency |
parentPaymentId required | string <= 32 characters Initial transaction Id |
description | string <= 512 characters Description of the transaction shown to the Customer. Can be sent outside of the system, to the payment provider or acquiring bank. |
object (PayoutCard) You must be PCI DSS compliant to collect card data on your side. If you are not certified, do not add this field to your request and we will collect the data on our Payment page. In case if you prefer working using s2s mode, make sure you've provided us with your latest PCI DSS certificate and AoC. | |
object (CustomerS2S) | |
object (BillingAddress) Customer's billing address | |
object (Receiver) Recipient's name when transferring P2P. | |
webhookUrl | string Url to receive payment status notifications (callbacks) |
object Additional parameters may be required by some payment providers or banks. Contact our Support or your personal Account Manager for more details. |
{- "referenceId": "payout_id=45768;custom_ref=123",
- "paymentType": "WITHDRAWAL",
- "paymentMethod": "BASIC_CARD",
- "amount": 12.12,
- "currency": "EUR",
- "parentPaymentId": "a0611ba1540d4062bc42d40196071f94",
- "description": "Payout for the account number 12345",
- "card": {
- "cardNumber": "4000 0000 0000 0002",
- "cardholderName": "Harry Potter",
- "expiryMonth": "07",
- "expiryYear": "2028"
}, - "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "receiver": {
- "firstName": "Harry",
- "lastName": "Potter",
- "iban": "HR1723600001101234565",
- "bankCode": "004",
- "bankName": "VirtualBank",
- "sortCode": "055555",
- "accountNumber": "0178524"
}, - "additionalParameters": {
- "blockchain": "TRX"
}
}
{- "timestamp": "2022-11-06T10:16:11.595+00:00",
- "status": 200,
- "result": {
- "id": "a0981ba1540d4062bc42d4019607sf94",
- "referenceId": "payout-123",
- "paymentType": "DEPOSIT",
- "state": "COMPLETED or PENDING",
- "description": "Payout for the account",
- "parentPaymentId": "a0981ba1540d4062bc42d4019607sf94",
- "paymentMethod": "BASIC_CARD",
- "paymentMethodDetails": {
- "customerAccountNumber": "400000***0002",
- "cardholderName": "Harry Potter",
- "cardExpiryMonth": "07",
- "cardExpiryYear": "2028"
}, - "amount": 12.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "terminalName": "string"
}
}
Payment request, used for REFUNDS
Refund Request - Request to initiate a transaction.
referenceId | string <= 256 characters Reference assigned by Merchant (referenceId is used ONLY internally and not sent to the payment provider OR acquiring bank) Will be sent unchanged within the PaymentResponse. |
paymentType required | string Payment Type |
paymentMethod | string (PaymentMethod) Enum: "ADVCASH" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ASTROPAY" "B2BINPAY" "BANKTRANSFER" "BASIC_CARD" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_HSP" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_PAYEER" "BITEXPRO_P2P" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_STICPAY" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "IBAN" "IDEAL" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MB" "MBWAY" "MISTERCASH" "MOBILE" "MOBILEMONEY" "MOBILEMONEY_AIRTEL" "MOBILEMONEY_BANKTRANSFER" "MOBILEMONEY_MPESA" "MOBILEMONEY_MTN" "MOBILEMONEY_ORANGE" "MOBILEMONEY_OZOW" "MOBILEMONEY_SNAPSCAN" "MOBILEMONEY_VODAFONE" "MOBILEMONEY_WAVE" "MOBILEMONEY_ZAMTEL" "MONETIX" "MONNET" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "PAGO_EFECTIVO" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYTM" "PEP" "PERFECTMONEY" "PICPAY" "PIX" "POLI" "PRZELEWY24" "PSEBANKTRANSFER" "QRCODE" "RAPID_TRANSFER" "RAPIDTRANSFER" "RAPYD" "RETAILCARD" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "WEBPAY" "WECHATWALLET" "ZALO" "MANDIRI" "REVOLUTPAY" "PAYSCROW" "PID" Payment Method |
amount required | number multiple of 1e-18 [ 1e-18 .. 999999.99 ] Payment amount |
currency required | string <ISO 4217 code for FIAT currencies or cryptocurrency symbol> Payment currency |
parentPaymentId required | string <= 32 characters Initial transaction Id |
description | string <= 512 characters Description of the transaction shown to the Customer. Can be sent outside of the system, to the payment provider or acquiring bank. |
returnUrl | string <= 256 characters URL to redirect the Customer after TX processing |
pendingReturnUrl | string <= 256 characters URL to redirect the Customer during TX processing. Overrides static value from Shop. |
successReturnUrl | string <= 256 characters URL to redirect the Customer after TX processing in case of success |
declineReturnUrl | string <= 256 characters URL to redirect the Customer after TX processing in case of decline |
webhookUrl | string Url to receive payment status notifications (callbacks) |
{- "referenceId": "payment_id=45768;custom_ref=123",
- "paymentType": "REFUND",
- "paymentMethod": "BASIC_CARD",
- "amount": 11.12,
- "currency": "EUR",
- "parentPaymentId": "a0611ba1540d4062bc42d40196071f94",
- "description": "Funding the account number 12345",
}
{- "timestamp": "2022-11-06T10:16:11.595+00:00",
- "status": 200,
- "result": {
- "id": "a0981ba1540d4062bc42d4019607sf94",
- "referenceId": "refund",
- "paymentType": "REFUND",
- "state": "COMPLETED or PENDING",
- "description": "Refund",
- "parentPaymentId": "a0981ba1540d4062bc42d4019607sf94",
- "paymentMethod": "BASIC_CARD",
- "paymentMethodDetails": {
- "customerAccountNumber": "400000***0002",
- "cardholderName": "Harry Potter",
- "cardExpiryMonth": "07",
- "cardExpiryYear": "2028"
}, - "amount": 11.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "terminalName": "string"
}
}
Payment - CheckStatus
id required | string/[a-zA-Z0-9]{32}/ Payment Id |
{- "timestamp": "2022-11-06T10:16:11.595+00:00",
- "status": 200,
- "result": {
- "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"
}, - "amount": 11.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "startRecurring": true,
- "recurringToken": "string",
- "terminalName": "string"
}
}
Get a list of operations performed during payment processing sorted by time (most recent first)
id required | string/[a-zA-Z0-9]{32}/ Payment Id |
{- "timestamp": "2022-11-06T10:16:11.595+00:00",
- "status": 200,
- "result": [
- {
- "id": 0,
- "operation": "CREATE_PAYMENT",
- "started": "2022-11-08T12:31:41.595+00:00",
- "completed": "2022-11-08T12:37:12.595+00:00",
- "paymentState": "COMPLETED or PENDING",
- "outgoingMessages": "string",
- "incomingMessages": "string"
}
]
}
Getting actual merchant's balance by terminalId for all processing currencies or any specific one. When sending a request with a specific terminalId, you will receive a list of balances for all currencies with a balance above 0. You can add a currency as a get request parameter and get only the balance of the specified currency. For example, add ?currency=EUR to the endpoint and get the balance in EUR. When you try to get a balance for a terminal that is not in the system, you will receive an error 404.
terminalId required | integer Terminal identifier |
currency | string Terminal currency |
{- "timestamp": "2022-10-05T11:23:12.595+00:00",
- "status": 200,
- "result": [
- {
- "terminalId": 621,
- "balance": {
- "amount": 2000,
- "currency": "EUR"
}
}
]
}
The list of mandatory required params may vary according to the paymentType used, see them attached below in the table: Note: please check all details with your Account Manager
paymentType | List of mandatory Required Params |
---|---|
DEPOSIT | paymentType, amount, currency, customer.firstName, customer.lastName, customer.email, customer.phone |
WITHDRAWAL | paymentType, parentPaymentId, amount, currency, customer.firstName, customer.lastName, customer.email, customer.phone, card.cardholderName, card.expiryMonth, card.expiryYear |
REFUND | paymentType, parentPaymentId, amount, currency |
CARDVERIFY | paymentType, amount, currency |
apiUrl for different environments should be the following:
Environment | Servers |
---|---|
Sandbox | https://app-demo.payadmit.com/api/v1/payments |
Production | https://app.payadmit.com/api/v1/payments |
To get the detailed information about processing volumes, reports, transactions, active users i.e., please visit our Merchant Portal with credentials given to you during the integration process:
Environment | Merchant Portal URL |
---|---|
Sandbox | https://mp-demo.payadmit.com/ |
Production | https://mp.payadmit.com/ |
In case if you want to use any specific blockchain under "CRYPTO" payment method, please specify the blockchain value via the payment request using "additionalParameters" object:
"additionalParameters":{ "blockchain": "TRX"}
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: "ADVCASH" "ALIPAY" "ALYCEPAY" "APPLEPAY" "ASTROPAY" "B2BINPAY" "BANKTRANSFER" "BASIC_CARD" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_HSP" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_PAYEER" "BITEXPRO_P2P" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_STICPAY" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "IBAN" "IDEAL" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MB" "MBWAY" "MISTERCASH" "MOBILE" "MOBILEMONEY" "MOBILEMONEY_AIRTEL" "MOBILEMONEY_BANKTRANSFER" "MOBILEMONEY_MPESA" "MOBILEMONEY_MTN" "MOBILEMONEY_ORANGE" "MOBILEMONEY_OZOW" "MOBILEMONEY_SNAPSCAN" "MOBILEMONEY_VODAFONE" "MOBILEMONEY_WAVE" "MOBILEMONEY_ZAMTEL" "MONETIX" "MONNET" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "PAGO_EFECTIVO" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYMAXIS" "PAYMAYA" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYTM" "PEP" "PERFECTMONEY" "PICPAY" "PIX" "POLI" "PRZELEWY24" "PSEBANKTRANSFER" "QRCODE" "RAPID_TRANSFER" "RAPIDTRANSFER" "RAPYD" "RETAILCARD" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "WEBPAY" "WECHATWALLET" "ZALO" "MANDIRI" "REVOLUTPAY" "PAYSCROW" "PID" Payment Method |
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 |
object (CustomerS2S) | |
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"
}, - "amount": 11.12,
- "currency": "EUR",
- "customerAmount": 15,
- "customerCurrency": "USD",
- "errorCode": "1.01",
- "externalResultCode": "03",
- "customer": {
- "referenceId": "VIP_customer_12345",
- "citizenshipCountryCode": "GB",
- "firstName": "Harry",
- "lastName": "Potter",
- "dateOfBirth": "1996-01-05",
- "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
}, - "billingAddress": {
- "addressLine1": "211, Victory street",
- "addressLine2": "Office 7B",
- "city": "Hogwarts",
- "countryCode": "GB",
- "postalCode": "01001",
- "state": "CA"
}, - "startRecurring": true,
- "recurringToken": "string",
- "terminalName": "string"
}
These states provide a comprehensive overview of the different stages a transaction may go through, allowing for better tracking, management, and resolution of any issues that may arise during the process.
State | Final TX State | Explanation |
---|---|---|
COMPLETED | yes | The transaction has been successfully processed. |
DECLINED | yes | The transaction has been rejected, often due to issues such as insufficient funds, security concerns, or other reasons preventing successful processing. |
CANCELLED | yes | The user or system has intentionally terminated the transaction before its completion or transaction got cancelled automatically due to timeout. |
ERROR | yes | The transaction has encountered an error during processing, and further action or investigation is required to resolve the issue. |
CHECKOUT | no | The transaction is in progress as the user is currently in the process of finalizing the payment or action. |
RECONCILIATION | no | The transaction is under review or reconciliation, usually involving checkState request. |
PENDING | no | The transaction is awaiting further processing or approval. It is in a temporary state and has not been completed or declined. |
AWAITING_WEBHOOK | no | The transaction is waiting for a webhook notification. |
AWAITING_REDIRECT | no | The transaction is waiting for a redirect action, typically in scenarios involving online payments where users may need to be redirected to another page for additional information. |
AWAITING_APPROVAL | no | The transaction is pending approval, often in scenarios where additional authorization is required before completing the WITHDRAWAL transaction. |
AWAITING_RETURN | no | The transaction is awaiting a customer return from the external API interface. |
CASCADING_CONFIRMATION | no | The transaction is undergoing customer approval for next provider within cascading list. |
To proceed with testing for all processing flows and cases, you can use our Sandbox environment, keep in mind that the amount should be less than 10000000. For withdrawals and refunds, the limit is 10000.
Card Number (PAN) | 3DS Result |
---|---|
4000 0000 0000 0002 | 3DS enrolled, successful authorization |
4242 4242 4242 4242 | 3DS enrolled, declined authorization |
4000 0000 0000 0408 | Not enrolled for 3DS, successful authorization |
4000 0000 0000 0416 | Not enrolled for 3DS, declined authorization |
Expiration date - any future.
CVV - any.
Code | Response Message |
---|---|
1.00 | Illegal Workflow State |
1.01 | Not Found |
1.02 | General Decline |
1.03 | Internal Server Error |
1.04 | Cancelled by Timeout |
1.05 | No suitable provider found |
1.06 | Recurring Token not Found |
1.07 | Payer Unaccepted |
1.08 | Invalid Amount |
1.09 | Invalid Currency |
2.00 | Cancelled by Customer |
3.00 | Declined by Acquirer |
3.01 | Declined by Acquirer: Anti-fraud |
3.02 | Declined by Acquirer: Request Validation |
3.03 | Acquirer Malfunction |
3.04 | Acquirer Timeout |
3.05 | Acquirer Limits Reached |
3.06 | Declined by Acquirer: Card Scheme |
3.07 | Declined by Acquirer: Card Data |
3.08 | Declined by Acquirer: Business Rules |
3.09 | Not Fully 3DS |
3.10 | Unknown Error Code |
3.11 | Payer cannot pay |
4.00 | Declined by Issuer |
4.01 | Insufficient Funds |
4.02 | Stolen Card |
4.03 | Lost card |
4.04 | Pick up card |
4.05 | Card Expired |
4.06 | Card Inactive |
4.07 | Card Suspended |
4.08 | Card Deleted |
4.09 | Invalid Card CVC/CVV |
5.00 | Declined by 3DS |
5.01 | 3DS Timeout |
6.00 | Declined by Internal Anti-fraud |
6.01 | Card PAN Blacklisted |
6.02 | Customer Email Blacklisted |
6.03 | Card Issuing Country Restricted |
6.04 | IP Country Restricted |
6.05 | Restricted Currency |
6.06 | Invalid Amount |
6.07 | IP Country Must Be Equal to Billing Country |
6.08 | IP Country Must Be Equal to Card Issuing Country |
6.09 | Billing Country Must Be Equal to Card Issuing Country |
6.10 | Payment Created Within Closed Period of Day |
6.11 | Card PAN not Whitelisted |
6.12 | Cardholder name is invalid |
6.21 | Limit exceeded: Number of completed deposits |
6.22 | Limit exceeded: Number of completed deposits for card |
6.23 | Limit exceeded: Number of declined deposits for card |
6.24 | Limit exceeded: Number of cards for IP address |
6.25 | Limit exceeded: Number of IP addresses for card |
6.26 | Limit exceeded: IP country does not match card country |
6.27 | Limit exceeded: Same amount and currency for card |
6.28 | Limit exceeded: Amount of deposits in specified currency |
6.29 | Limit exceeded: Amount of deposits for card and currency |
6.30 | Limit exceeded: Amount of deposits in base currency |
6.31 | Limit exceeded: Amount of deposits for card in base currency |
6.32 | Limit exceeded: Number of IP countries for card |
6.33 | Limit exceeded: Amount of deposits in base currency, for card |
6.34 | Limit exceeded: Number of attempts with all statuses, times per card |
7.00 | Declined by External Anti-fraud |
7.01 | External Anti-fraud Communication Problem |