API docs by Redocly

xazurpay.com API (1.2.324)

Download OpenAPI specification:Download

Support: [email protected] License: Apache 2.0

Payment API

Payment

Merchant Payments API

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=2021-10-13T10:26:18

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=2021-10-13T10:39:34

If passed, return only payments created strictly before the specified time

updated.gte
string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)>
Example: updated.gte=2021-10-13T10:26:18

If passed, return only payments updated at or after the specified time

updated.lt
string <ISO 8601 (YYYY-MM-DD'T'HH24:MI:SS)>
Example: updated.lt=2021-10-13T10:39:34

If passed, return only payments updated strictly before the specified time

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2020-10-07T13:36:32.595+00:00",
  • "status": 200,
  • "hasMore": true,
  • "result": [
    ]
}

createPayment

Payment request, used for DEPOSITS, WITHDRAWALS and REFUNDS

Authorizations:
bearerAuthentication
Request Body schema: application/json

Payment Request - Request to initiate a payment

referenceId
string <= 256 characters

Reference assigned by Merchant. Will not go outside the system. Will be sent unchanged in the PaymentResponse.

paymentType
required
string (PaymentType)
Enum: "DEPOSIT" "WITHDRAWAL" "REFUND"

Payment Type

paymentMethod
string (PaymentMethod)
Enum: "BASIC_CARD" "CRYPTO" "FLEXEPIN" "MACROPAY" "SKRILL" "PAYRETAILERS" "LOCALPAYMENT" "MONNET" "PAYPAL" "NETELLER" "TRUSTPAYMENTS" "PAYMAXIS" "GATE8TRANSACT" "TINK" "B2BINPAY" "CLICK" "MONETIX" "PERFECTMONEY" "VOLT" "KESSPAY" "BILLLINE" "NGENIUS" "ASTROPAY" "ALYCEPAY" "PIX" "BOLETO" "UPI" "PAYTM" "NETBANKING" "FINRAX" "SPOYNT" "XINPAY" "OMNIMATRIX" "DPOPAY" "EXTERNAL_HPP" "XANPAY" "INRPAY" "ARI10" "SOFORT" "GIROPAY" "PAYSAFECARD" "PAYSAFECASH" "OPEN_BANKING" "KLARNA" "SPEI" "PAYCASH" "RAPIPAGO" "PAGOFACIL" "RAPIDTRANSFER" "MOBILE_MONEY" "INTERAC" "INTERAC_ETO" "INTERAC_RTO" "INTERAC_ACH" "PICPAY" "MOLLIE" "TED" "ZIPAY" "PSE" "EFECTY" "BANKTRANSFER" "PEC" "OXXO" "WEBPAY" "PAGOEFECTIVO" "MIFINITY" "PAYPORT" "JETONCASH" "JETONWALLET" "NODA" "NODA_REVOLUT" "ALFAKIT" "PAYFUN" "EMANAT" "M10" "RUBPAY" "MONERCHY" "MUCHBETTER" "YAPILY" "INAI" "IMPS" "RTGS" "PAYID" "ZOTAPAY" "SBP" "P2P_CARD" "P2P_IBAN" "P2P_SBP" "PUSH" "GATEIQ" "VIETTEL" "ZALO" "QR" "CUP" "CODI" "PAY2PLAY" "BKASH" "NAGAD" "ROCKET" "VIRTUAL_ACCOUNT" "MULTIBANCO" "BLIK" "MBWAY" "P24" "MISTERCASH" "MACH" "KHIPU" "NEFT" "STICPAY" "SBERPAY" "MOBILE_COMMERCE" "BINANCE_PAY" "MPAY" "CHEK" "KLAP_EFECTIVO" "KLAP_TRANSFERENCIA" "PAGO46" "HITES" "SERVIFACIL" "OPENPAYD" "FAWRY" "EPS" "IDEAL" "PAYOUT_SEPA_BATCH" "PAYOUT_NONSEPA_REQUEST"

Payment Method

amount
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

Id of initial deposit for refunds, Id of initial recurring payment for subsequent payments

description
string <= 512 characters

Description of the transaction shown to the Customer. Can be sent outside the system.

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 page.

object (Customer)
object (BillingAddress)

Customer's billing address

returnUrl
string <= 256 characters

URL to redirect Customer after processing

webhookUrl
string

Url to receive payment status notifications

startRecurring
boolean

Send 'true' if you want this payment to initiate recurring chain. Default is 'false'.

recurringToken
string

To continue recurring chain, send a token from a previously initiated recurring payment.

object (SubscriptionRequest)

Subscription to bill customers at regular intervals. Used only with 'startRecurring=true'.

object

Additional parameters required by some payment providers. Contact support for more information.

Responses

Request samples

Content type
application/json
{
  • "referenceId": "payment_id=123;custom_ref=456",
  • "paymentType": "DEPOSIT",
  • "paymentMethod": "BASIC_CARD",
  • "amount": 11.12,
  • "currency": "EUR",
  • "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
  • "description": "Deposit 123 via TEST shop",
  • "card": {
    },
  • "customer": {
    },
  • "billingAddress": {
    },
  • "returnUrl": "https://mywebsite.com/{id}/{referenceId}/{state}/{type}",
  • "webhookUrl": "https://mywebsite.com/webhooks",
  • "startRecurring": true,
  • "recurringToken": "string",
  • "subscription": {
    },
  • "additionalParameters": {
    }
}

Response samples

Content type
application/json
{
  • "timestamp": "2020-10-07T13:36:32.595+00:00",
  • "status": 200,
  • "result": {
    }
}

getPayment

Find Payment by Id

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

Payment Id

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2020-10-07T13:36:32.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": "2020-10-07T13:36:32.595+00:00",
  • "status": 200,
  • "result": [
    ]
}

Subscription

Recurring Subscription API

getSubscription

Find Subscription by Id

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

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2020-10-07T13:36:32.595+00:00",
  • "status": 200,
  • "result": {
    }
}

patchSubscription

Patch Subscription

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

Subscription Id

Request Body schema: application/json

Subscription patch request

state
string
Value: "CANCELLED"

New subscription state

Responses

Request samples

Content type
application/json
{
  • "state": "CANCELLED"
}

Response samples

Content type
application/json
{
  • "timestamp": "2020-10-07T13:36:32.595+00:00",
  • "status": 200,
  • "result": {
    }
}

Webhooks

In order to receive webhooks from our system you need to specify 'Webhook Url' in shop settings or provide 'webhookUrl' parameter in createPayment request. The request parameter takes precedence over the parameter specified in shop settings.

To ensure that webhooks come from our system, you can generate a Signing Key in your shop settings. If the Signing Key is specified, webhooks from our system will include 'Signature' header with HMAC-SHA256 hash generated from JSON body and Signing Key.

id
string <= 32 characters

Payment Id

referenceId
string <= 256 characters

referenceId from payment request

paymentType
string (PaymentType)
Enum: "DEPOSIT" "WITHDRAWAL" "REFUND"

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

paymentMethod
string (PaymentMethod)
Enum: "BASIC_CARD" "CRYPTO" "FLEXEPIN" "MACROPAY" "SKRILL" "PAYRETAILERS" "LOCALPAYMENT" "MONNET" "PAYPAL" "NETELLER" "TRUSTPAYMENTS" "PAYMAXIS" "GATE8TRANSACT" "TINK" "B2BINPAY" "CLICK" "MONETIX" "PERFECTMONEY" "VOLT" "KESSPAY" "BILLLINE" "NGENIUS" "ASTROPAY" "ALYCEPAY" "PIX" "BOLETO" "UPI" "PAYTM" "NETBANKING" "FINRAX" "SPOYNT" "XINPAY" "OMNIMATRIX" "DPOPAY" "EXTERNAL_HPP" "XANPAY" "INRPAY" "ARI10" "SOFORT" "GIROPAY" "PAYSAFECARD" "PAYSAFECASH" "OPEN_BANKING" "KLARNA" "SPEI" "PAYCASH" "RAPIPAGO" "PAGOFACIL" "RAPIDTRANSFER" "MOBILE_MONEY" "INTERAC" "INTERAC_ETO" "INTERAC_RTO" "INTERAC_ACH" "PICPAY" "MOLLIE" "TED" "ZIPAY" "PSE" "EFECTY" "BANKTRANSFER" "PEC" "OXXO" "WEBPAY" "PAGOEFECTIVO" "MIFINITY" "PAYPORT" "JETONCASH" "JETONWALLET" "NODA" "NODA_REVOLUT" "ALFAKIT" "PAYFUN" "EMANAT" "M10" "RUBPAY" "MONERCHY" "MUCHBETTER" "YAPILY" "INAI" "IMPS" "RTGS" "PAYID" "ZOTAPAY" "SBP" "P2P_CARD" "P2P_IBAN" "P2P_SBP" "PUSH" "GATEIQ" "VIETTEL" "ZALO" "QR" "CUP" "CODI" "PAY2PLAY" "BKASH" "NAGAD" "ROCKET" "VIRTUAL_ACCOUNT" "MULTIBANCO" "BLIK" "MBWAY" "P24" "MISTERCASH" "MACH" "KHIPU" "NEFT" "STICPAY" "SBERPAY" "MOBILE_COMMERCE" "BINANCE_PAY" "MPAY" "CHEK" "KLAP_EFECTIVO" "KLAP_TRANSFERENCIA" "PAGO46" "HITES" "SERVIFACIL" "OPENPAYD" "FAWRY" "EPS" "IDEAL" "PAYOUT_SEPA_BATCH" "PAYOUT_NONSEPA_REQUEST"

Payment Method

object (PaymentMethodDetails)
amount
number multiple of 1e-18 [ 1e-18 .. 999999.99 ]

Amount sent to the payment provider

currency
string <ISO 4217 code for FIAT currencies or cryptocurrency symbol>

Currency sent to the payment provider

customerAmount
number

Amount from payment request. Filled only 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. Filled only if it differs from the currency sent to the payment provider.

redirectUrl
string <= 256 characters

URL to redirect the customer

errorCode
string

Check 'Error Codes' section for details

externalResultCode
string

Result code from external provider

object (Customer)
object (BillingAddress)

Customer's billing address

startRecurring
boolean

Indicates whether this payment has started a recurring chain

recurringToken
string

Token that can be used to continue the recurring chain

terminalName
string

The name of the provider that was used to process this payment

externalFeeAmount
number

Provider fee. Filled only if supported by the provider.

externalFeeCurrency
string <ISO 4217 code for FIAT currencies or cryptocurrency symbol>

Provider fee currency. Filled only if supported by the provider.

{
  • "id": "91d27876e87f4b22b3ecd53924bf973d",
  • "referenceId": "payment-123",
  • "paymentType": "DEPOSIT",
  • "state": "PENDING",
  • "description": "Deposit via TEST shop",
  • "parentPaymentId": "91d27876e87f4b22b3ecd53924bf973d",
  • "paymentMethod": "BASIC_CARD",
  • "paymentMethodDetails": {
    },
  • "amount": 11.12,
  • "currency": "EUR",
  • "customerAmount": 15,
  • "customerCurrency": "USD",
  • "redirectUrl": "http://start/payment/6ccaa03cb2c242a68ce332f38fedfad7",
  • "errorCode": "1.01",
  • "externalResultCode": "03",
  • "customer": {
    },
  • "billingAddress": {
    },
  • "startRecurring": true,
  • "recurringToken": "string",
  • "terminalName": "string",
  • "externalFeeAmount": 15,
  • "externalFeeCurrency": "USD"
}

Sandbox

For a successful deposit in the sandbox environment, the amount should be less than 10000000. For test withdrawals and refunds, the limit is 10000.

Test cards

Card Number Result
4000 0000 0000 0002 3D-Secure enrolled, successful authorization
4242 4242 4242 4242 3D-Secure enrolled, declined authorization
4000 0000 0000 0408 Not enrolled for 3D-Secure, successful authorization
4000 0000 0000 0416 Not enrolled for 3D-Secure, declined authorization

Error Codes

Code Description
1.00 Illegal Workflow State
1.01 Not Found
1.02 Communication Problem
1.03 Internal Server Error
1.04 Cancelled by Timeout
1.05 Terminal not 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
3.12 Invalid ID Document
3.13 ID Document Restrictions
3.14 Declined Due to Age Requirements
3.15 ID Document Under Temporary Restrictions
4.00 Declined by Issuer
4.01 Insufficient Funds
4.02 Do Not Honor
4.03 Declined by Issuer: Invalid Card Number
4.04 Declined by Issuer: Expired Card
4.05 Issuer Limits Reached
4.06 Card Lost or Stolen
4.07 Invalid Security Code
4.08 Declined by Issuer: Business Rules
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 The same card is used by different customers
6.14 Customer Phone Blacklisted
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 for customer in base currency
6.34 Limit exceeded: Withdrawal amount for customer in base currency
6.35 Billing Country Restricted
6.36 Customer Citizenship Country Restricted
7.00 Declined by External Anti-fraud
7.01 External Anti-fraud Communication Problem