API docs by Redocly

payadmit.com API (1.0.2522)

Download OpenAPI specification:Download

Support: [email protected] License: Apache 2.0

PayAdmit API Specification

Payment API Specs

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.

getPayments

Get a list of payments sorted by creation date (most recent first)

Authorizations:
bearerAuthentication
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2022-10-05T11:23:12.595+00:00",
  • "status": 200,
  • "hasMore": true,
  • "result": [
    ]
}

createPayment

Payment request, used for DEPOSITS

Authorizations:
bearerAuthentication
Request Body schema: application/json

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.

One of
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" "ASUPAY" "B2BINPAY" "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" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_APPLEPAY" "BITEXPRO_BANKTRANSFER" "BITEXPRO_BKASH" "BITEXPRO_BLIK" "BITEXPRO_NEOSURF" "BITEXPRO_BANCONTACT" "BITEXPRO_P24" "BITEXPRO_MULTIBANCO" "BITEXPRO_MBWAY" "BITEXPRO_RN," "BITEXPRO_MEEZAR2P," "BITEXPRO_MEEZAQR," "BITEXPRO_VODAFONE," "BITEXPRO_TRUSTLY" "BITEXPRO_IDEAL" "BITEXPRO_EUROAPM" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_GPAY" "BITEXPRO_HSP" "BITEXPRO_MOBILEMONEY" "BITEXPRO_NAGAD" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_P2P" "BITEXPRO_PAPARA" "BITEXPRO_PAYEER" "BITEXPRO_PAYSAFECARD" "BITEXPRO_PAYSAFECASH" "BITEXPRO_PAYTM" "BITEXPRO_PIX" "BITEXPRO_RAPID" "BITEXPRO_ROCKET" "BITEXPRO_SBERPAY" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_SBP" "BITEXPRO_SPEI" "BITEXPRO_STICPAY" "BITEXPRO_UPI" "BITEXPRO_WALLET" "BITEXPRO_OPENBANKING" "BITEXPRO_CASH," "BITEXPRO_EWALLET" "BKASH" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DINO" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EPS" "EUPAGO" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "HUMO" "IBAN" "IDEAL" "IMPS" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MANDIRI" "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" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "NUMIPAY_HPP" "NUMIPAY_VOUCHER" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "P2P" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAGO_EFECTIVO" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYLER" "PAYMATRIX" "PAYMAXIS" "PAYMAYA" "PAYMEMOBILE" "PAYMOMENTUM" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYSCROW" "PAYTM" "PAY_SHOP" "PEP" "PERFECTMONEY" "PICPAY" "PID" "PIX" "POLI" "PRISMA_LINK" "PRZELEWY24" "PSEBANKTRANSFER" "QBIT" "QRCODE" "RAPIDTRANSFER" "RAPID_TRANSFER" "RAPYD" "RETAILCARD" "REVOLUTPAY" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "SPELL" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "UZCARD" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "VOUCHSTAR" "WEBPAY" "WECHATWALLET" "ZALO"

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)

websiteUrl
string

Merchant Website Processing URL reference

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.

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200,
  • "result": {
    }
}

createPayout

Payment request, used for WITHDRAWALS

Authorizations:
bearerAuthentication
Request Body schema: application/json

Payout Request - Request to initiate a transaction.

One of
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" "ASUPAY" "B2BINPAY" "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" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_APPLEPAY" "BITEXPRO_BANKTRANSFER" "BITEXPRO_BKASH" "BITEXPRO_BLIK" "BITEXPRO_NEOSURF" "BITEXPRO_BANCONTACT" "BITEXPRO_P24" "BITEXPRO_MULTIBANCO" "BITEXPRO_MBWAY" "BITEXPRO_RN," "BITEXPRO_MEEZAR2P," "BITEXPRO_MEEZAQR," "BITEXPRO_VODAFONE," "BITEXPRO_TRUSTLY" "BITEXPRO_IDEAL" "BITEXPRO_EUROAPM" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_GPAY" "BITEXPRO_HSP" "BITEXPRO_MOBILEMONEY" "BITEXPRO_NAGAD" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_P2P" "BITEXPRO_PAPARA" "BITEXPRO_PAYEER" "BITEXPRO_PAYSAFECARD" "BITEXPRO_PAYSAFECASH" "BITEXPRO_PAYTM" "BITEXPRO_PIX" "BITEXPRO_RAPID" "BITEXPRO_ROCKET" "BITEXPRO_SBERPAY" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_SBP" "BITEXPRO_SPEI" "BITEXPRO_STICPAY" "BITEXPRO_UPI" "BITEXPRO_WALLET" "BITEXPRO_OPENBANKING" "BITEXPRO_CASH," "BITEXPRO_EWALLET" "BKASH" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DINO" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EPS" "EUPAGO" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "HUMO" "IBAN" "IDEAL" "IMPS" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MANDIRI" "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" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "NUMIPAY_HPP" "NUMIPAY_VOUCHER" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "P2P" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAGO_EFECTIVO" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYLER" "PAYMATRIX" "PAYMAXIS" "PAYMAYA" "PAYMEMOBILE" "PAYMOMENTUM" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYSCROW" "PAYTM" "PAY_SHOP" "PEP" "PERFECTMONEY" "PICPAY" "PID" "PIX" "POLI" "PRISMA_LINK" "PRZELEWY24" "PSEBANKTRANSFER" "QBIT" "QRCODE" "RAPIDTRANSFER" "RAPID_TRANSFER" "RAPYD" "RETAILCARD" "REVOLUTPAY" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "SPELL" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "UZCARD" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "VOUCHSTAR" "WEBPAY" "WECHATWALLET" "ZALO"

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
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)

websiteUrl
string

Merchant Website Processing URL reference

object

Additional parameters may be required by some payment providers or banks. Contact our Support or your personal Account Manager for more details.

Responses

Request samples

Content type
application/json
Example
{
  • "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": {
    },
  • "customer": {
    },
  • "billingAddress": {
    },
  • "receiver": {
    },
  • "webhookUrl": "https://yourwebsite.com/callbacks/payadmit",
  • "websiteUrl": "https://yourwebsite.com",
  • "additionalParameters": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200,
  • "result": {
    }
}

createRefund

Payment request, used for REFUNDS

Authorizations:
bearerAuthentication
Request Body schema: application/json

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" "ASUPAY" "B2BINPAY" "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" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_APPLEPAY" "BITEXPRO_BANKTRANSFER" "BITEXPRO_BKASH" "BITEXPRO_BLIK" "BITEXPRO_NEOSURF" "BITEXPRO_BANCONTACT" "BITEXPRO_P24" "BITEXPRO_MULTIBANCO" "BITEXPRO_MBWAY" "BITEXPRO_RN," "BITEXPRO_MEEZAR2P," "BITEXPRO_MEEZAQR," "BITEXPRO_VODAFONE," "BITEXPRO_TRUSTLY" "BITEXPRO_IDEAL" "BITEXPRO_EUROAPM" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_GPAY" "BITEXPRO_HSP" "BITEXPRO_MOBILEMONEY" "BITEXPRO_NAGAD" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_P2P" "BITEXPRO_PAPARA" "BITEXPRO_PAYEER" "BITEXPRO_PAYSAFECARD" "BITEXPRO_PAYSAFECASH" "BITEXPRO_PAYTM" "BITEXPRO_PIX" "BITEXPRO_RAPID" "BITEXPRO_ROCKET" "BITEXPRO_SBERPAY" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_SBP" "BITEXPRO_SPEI" "BITEXPRO_STICPAY" "BITEXPRO_UPI" "BITEXPRO_WALLET" "BITEXPRO_OPENBANKING" "BITEXPRO_CASH," "BITEXPRO_EWALLET" "BKASH" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DINO" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EPS" "EUPAGO" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "HUMO" "IBAN" "IDEAL" "IMPS" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MANDIRI" "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" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "NUMIPAY_HPP" "NUMIPAY_VOUCHER" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "P2P" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAGO_EFECTIVO" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYLER" "PAYMATRIX" "PAYMAXIS" "PAYMAYA" "PAYMEMOBILE" "PAYMOMENTUM" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYSCROW" "PAYTM" "PAY_SHOP" "PEP" "PERFECTMONEY" "PICPAY" "PID" "PIX" "POLI" "PRISMA_LINK" "PRZELEWY24" "PSEBANKTRANSFER" "QBIT" "QRCODE" "RAPIDTRANSFER" "RAPID_TRANSFER" "RAPYD" "RETAILCARD" "REVOLUTPAY" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "SPELL" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "UZCARD" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "VOUCHSTAR" "WEBPAY" "WECHATWALLET" "ZALO"

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)

websiteUrl
string

Merchant Website Processing URL reference

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200,
  • "result": {
    }
}

confirmPayout

The purpose of the endpoint is to approve or decline payouts via API. It allows the user to confirm or reject payment transactions based on specified criteria or business rules using API request.

Authorizations:
bearerAuthentication
Request Body schema: application/json

Confirm Payout Request - Request to confirm or decline payout.

id
required
string/[a-zA-Z0-9]{32}/

Id of Payment.

action
required
string (ConfirmPayoutType)
Enum: "PROCESS" "DECLINE"

Confirm Payout Type

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "action": "PROCESS"
}

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200
}

checkStatus

Payment - CheckStatus

Authorizations:
bearerAuthentication
path Parameters
id
required
string/[a-zA-Z0-9]{32}/

Payment Id

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200,
  • "result": {
    }
}

getOperations

Get a list of operations performed during payment processing sorted by time (most recent first)

Authorizations:
bearerAuthentication
path Parameters
id
required
string/[a-zA-Z0-9]{32}/

Payment Id

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200,
  • "result": [
    ]
}

getBalance

Getting actual merchant's balance by terminalId for all processing currencies or any specific one. When sending a request with a particular terminalId, you will receive a list of balances for all currencies. 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 ID which doesn’t exist in the system, you will receive 404 error code.

Authorizations:
bearerAuthentication
path Parameters
terminalId
required
integer

Terminal identifier

query Parameters
currency
string

Terminal currency

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2022-10-05T11:23:12.595+00:00",
  • "status": 200,
  • "result": [
    ]
}

generateToken

Generate OAuth2Token for authorization

Authorizations:
bearerBase64Authentication
header Parameters
Authorization
required
string

Bearer + base64(login password)

Responses

Response samples

Content type
application/json
{
  • "token": "a694f527d516121d211dba7c52271d85",
  • "expires_in": 60
}

updateBlacklist

Update Black List

Authorizations:
bearerAuthentication
Request Body schema: application/json

Black List Request

Array
merchantId
required
integer
cardMask
string
customerEmail
string
customerPhone
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

updateWhitelist

Request for whitelisting customers, cards and emails

Authorizations:
bearerAuthentication
Request Body schema: application/json

Update Whitelist Request - Request to whitelist data.

merchantId
required
number

Id of Merchant.

terminalId
required
number

Id of Terminal.

customerEmail
string <email>

Email address of the customer for whitelisting

customerId
string

Customer Id for whitelisting

cardMask
string

Card mask for whitelisting.

Responses

Request samples

Content type
application/json
{
  • "merchantId": 123,
  • "terminalId": 123,
  • "customerEmail": "[email protected]",
  • "customerId": "customer_1",
  • "cardMask": "400000***0002"
}

Response samples

Content type
application/json
{
  • "timestamp": "2022-11-06T10:16:11.595+00:00",
  • "status": 200
}

Custom Payment Routing Fields

This section contains fields that can influence payment routing configurations

routingGroup

Type: string (maximum 64 characters)
Description: Identifies the customer as part of a specific group used for routing. This parameter enables segregating customers into different routing strategies for customized handling.

kycStatus

Type: boolean
Description: Indicates whether the customer has successfully passed Know Your Customer (KYC) verification.
Possible Values:

  • true: KYC verification passed
  • false: KYC verification not passed

paymentInstrumentKycStatus

Type: boolean
Description: Indicates whether the payment instrument (e.g., a credit card) associated with the customer has passed KYC verification.
Possible Values:

  • true: Payment instrument KYC verification passed
  • false: Payment instrument KYC verification not passed

dateOfFirstDeposit

Type: string (ISO 8601 format: YYYY-MM-DD)
Description: Represents the date of the customer's first deposit. The format adheres to the ISO 8601 standard.

depositsAmount

Type: integer
Description: The total amount deposited by the customer, expressed in the base currency of the system (EUR).

withdrawalsAmount

Type: integer
Description: The total amount withdrawn by the customer, expressed in the base currency of the system (EUR).

depositsCnt

Type: integer
Description: The number of deposit transactions made by the customer.

withdrawalsCnt

Type: integer
Description: The number of withdrawal transactions made by the customer.

trustLevel

Type: string
Description: Used to classify customer traffic into primary or secondary streams.
Possible Values:

  • ftd: First-Time Deposit traffic
  • redep: Redeposit traffic

btag

Type: boolean
Description: Determines a separation of customer traffic.
Possible Values:

  • true: Traffic marked as primary
  • false: Traffic marked as secondary

affiliated

Type: string (maximum 3 characters)
Description: Specifies affiliate-related configurations for routing.
Possible Values:

  • yes: Indicates affiliate-based routing
  • no: No affiliate-based routing

Mandatory Required Params

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

Required params per paymentType

paymentType List of mandatory Required Params
DEPOSIT paymentType, amount, currency, customer.firstName, customer.lastName, customer.email, customer.phone
WITHDRAWAL paymentType, 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

API Processing URLs

apiUrl for different environments should be the following:

apiUrl values

Environment Servers
Sandbox https://app-demo.payadmit.com/api/v1/payments
Production https://app.payadmit.com/api/v1/payments

Merchant Portal Access

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:

Merchant Portal URLs

Environment Merchant Portal URL
Sandbox https://mp-demo.payadmit.com/
Production https://mp.payadmit.com/

Crypto Processing Payment Method

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"}

Callbacks

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" "ASUPAY" "B2BINPAY" "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" "BEELINE" "BILLLINE" "BITEXPRO" "BITEXPRO_ADVCARD" "BITEXPRO_ADVWALLET" "BITEXPRO_APPLEPAY" "BITEXPRO_BANKTRANSFER" "BITEXPRO_BKASH" "BITEXPRO_BLIK" "BITEXPRO_NEOSURF" "BITEXPRO_BANCONTACT" "BITEXPRO_P24" "BITEXPRO_MULTIBANCO" "BITEXPRO_MBWAY" "BITEXPRO_RN," "BITEXPRO_MEEZAR2P," "BITEXPRO_MEEZAQR," "BITEXPRO_VODAFONE," "BITEXPRO_TRUSTLY" "BITEXPRO_IDEAL" "BITEXPRO_EUROAPM" "BITEXPRO_BPWALLET" "BITEXPRO_CRYPTO" "BITEXPRO_EXPAY" "BITEXPRO_GIROPAY" "BITEXPRO_GPAY" "BITEXPRO_HSP" "BITEXPRO_MOBILEMONEY" "BITEXPRO_NAGAD" "BITEXPRO_NETELLER" "BITEXPRO_OPENBANK" "BITEXPRO_P2P" "BITEXPRO_PAPARA" "BITEXPRO_PAYEER" "BITEXPRO_PAYSAFECARD" "BITEXPRO_PAYSAFECASH" "BITEXPRO_PAYTM" "BITEXPRO_PIX" "BITEXPRO_RAPID" "BITEXPRO_ROCKET" "BITEXPRO_SBERPAY" "BITEXPRO_SKRILL" "BITEXPRO_SOFORT" "BITEXPRO_SBP" "BITEXPRO_SPEI" "BITEXPRO_STICPAY" "BITEXPRO_UPI" "BITEXPRO_WALLET" "BITEXPRO_OPENBANKING" "BITEXPRO_CASH," "BITEXPRO_EWALLET" "BKASH" "BLIK" "BOLETO" "CARDSHPP" "CASH" "CHEK" "CLICK" "COMMUNITYBANKING" "CRYPTO" "DANA" "DINO" "DEBITWAY" "EFECTY" "EFT" "EMPAYRE" "EPAY" "EPS" "EUPAGO" "EWALLET" "EZPAY" "FLEXEPIN" "FPS" "GATE8TRANSACT" "GATEEXPRESS" "GCASH" "GIROPAY" "GOOGLEPAY" "HAVALE" "HAYHAY" "HITES" "HUMO" "IBAN" "IDEAL" "IMPS" "INSTANTQR" "INTERAC" "KAKAOPAY" "KCELL" "KESSPAY" "KHIPU" "KHIPUBANKTRANSFER" "LATAM_CASH" "LINK_AJA" "LOCALP2P" "LOCALPAYMENT" "LOTÉRICA" "MACH" "MACROPAY" "MANDIRI" "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" "MULTIBANCO" "NETBANKING" "NETELLER" "NGENIUS" "NUMIPAY_HPP" "NUMIPAY_VOUCHER" "ONLINEBANKING" "ONLINEBANKINGBTV" "OPENBANKING" "OVO" "OXXO" "P24" "P2C" "P2P" "PAGOEFECTIVОCASH" "PAGOEFECTIVОONLINE" "PAGO_EFECTIVO" "PAPARA" "PAPARAPOOL" "PAYBOL" "PAYCELL" "PAYCO" "PAYCOS" "PAYFIX" "PAYID" "PAYLER" "PAYMATRIX" "PAYMAXIS" "PAYMAYA" "PAYMEMOBILE" "PAYMOMENTUM" "PAYPAL" "PAYRETAILERS" "PAYRIVER" "PAYSAFECARD" "PAYSAFECASH" "PAYSCROW" "PAYTM" "PAY_SHOP" "PEP" "PERFECTMONEY" "PICPAY" "PID" "PIX" "POLI" "PRISMA_LINK" "PRZELEWY24" "PSEBANKTRANSFER" "QBIT" "QRCODE" "RAPIDTRANSFER" "RAPID_TRANSFER" "RAPYD" "RETAILCARD" "REVOLUTPAY" "SAFETYPAY" "SAMSUNGPAY" "SEPA" "SKRILL" "SLYSE" "SOFORT" "SPEI" "SPELL" "STRIPE" "SWIFT" "TINK" "TODITO" "TPAGA" "TRUEMONEY" "TRUSTLY" "TRUSTPAYMENTS" "UNIONPAYCARDS" "UPI" "UZCARD" "VIETQR" "VIETTELPAY" "VIRTUALACCOUNT" "VOLT" "VOUCHERS" "VOUCHSTAR" "WEBPAY" "WECHATWALLET" "ZALO"

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": {
    },
  • "amount": 11.12,
  • "currency": "EUR",
  • "customerAmount": 15,
  • "customerCurrency": "USD",
  • "redirectUrl": "http://init/txid/a0981ba1540d4062bc42d4019607sf94",
  • "errorCode": "1.01",
  • "externalResultCode": "03",
  • "customer": {
    },
  • "billingAddress": {
    },
  • "startRecurring": true,
  • "recurringToken": "string",
  • "terminalName": "string"
}

Transaction Statuses

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.
CHARGEBACK yes The transaction was marked as a chargeback, this process typically involves several states or stages, which may vary depending on the payment processor or bank.
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.

Sandbox Tools

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. Using card 4000…0002 will emulate 3DSecure scenario, to complete the payment you must enter the expected 3DSecure One-time password.

Test cards

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.
3DSecure OTP: 12345

Alternative Payment Methods

Payment Method Username Password
BANKTRANSFER banktransfer@emulator.test banktransfertest
NETELLER neteller@emulator.test netellertest
SKRILL skrill@emulator.test skrilltest
GIROPAY giropay@emulator.test giropaytest
PAYID payid@emulator.test payidtest
SOFORT sofort@emulator.test soforttest
STRIPE stripe@emulator.test stripetest

Response Codes And Messages

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
1.10 Velocity Limit Reached
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
4.10 Invalid Card Details
4.11 Declined by Issuer: Restricted Card
4.12 Declined by Issuer: Processing Limits
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.13 CardPAN Masked Blacklisted
6.14 Customer Phone Blacklisted
6.15 Card BIN Blacklisted
6.16 Customer email 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
6.35 Limit exceeded: Limit exceeded: Count of unique cards per customer email
7.00 Declined by External Anti-fraud
7.01 External Anti-fraud Communication Problem
8.00 Declined by Merchant