Skip to content
Deposits/
Create a payment

NapoleonPay API Docs (1.1.0)

NapoleonPay payment gateway API for creating payments

Download OpenAPI description
api.json
api.yaml
Languages
Servers
https://api.napoleonpay.com

Deposits

Operations related to creating and managing deposits

Operations

Create a payment

Request

Create a payment via Apple Pay, Google Pay, BLIK, CARD, ONRAMP, PAYID using a single endpoint. The request schema depends on paymentMethod.

Security
Bearer
Headers
Authorizationstringrequired

Bearer token for authentication

Signaturestringrequired

HMAC SHA-256 signature of the request payload

Bodyapplication/jsonrequired
paymentTypestring(PaymentType)required
Value"DEPOSIT"
paymentMethodstringrequired
Enum"APPLEPAY""GOOGLEPAY""BLIK""CARD""ONRAMP""ONRAMP_PAYID""ONRAMP_PIX""ONRAMP_ZAR""ONRAMP_PSE""ONRAMP_KHIPU"
Discriminator
amountnumber(float)> 0required
currencystringrequired
externalApiIdstring or null
customerobject(CustomerInfo)

Customer information (all fields optional unless specified by method).

billingAddressobject(BillingAddress)

Billing address (fields optional unless required by method).

additionalParametersobject(AdditionalParameters)

Method-specific parameters (e.g., BLIK purpose).

descriptionstring or null
referencestring or null
webhookUrlstring or nullrequired
returnUrlstring or nullrequired
browserobject(Browser)

Browser information (commonly required for wallet-based methods).

curl -i -X POST \
  https://api.napoleonpay.com/api/v1/payments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Signature: string' \
  -d '{
    "paymentType": "DEPOSIT",
    "paymentMethod": "APPLEPAY",
    "amount": 20,
    "currency": "EUR",
    "reference": "YOUR-SYSTEM-TRX-ID",
    "billingAddress": {
      "countryCode": "LT"
    },
    "returnUrl": "https://example.com/return",
    "webhookUrl": "https://example.com/webhook"
  }'

Responses

Payment created successfully.

Webhooks (payment status update)

NapoleonPay sends a POST request to your webhookUrl when the payment status changes. Below you can find examples of webhooks based on the paymentMethod that you should expect once the payment is completed.

CARD

{
  "id": "019ab727-1378-795a-bec3-1fa75dd18f48",
  "paymentStatus": "COMPLETED",
  "created": {
    "date": "2025-11-24 20:36:23.000000",
    "timezone_type": 3,
    "timezone": "Europe/Vilnius"
  },
  "paymentType": "DEPOSIT",
  "description": "Test payin",
  "paymentMethod": "CARD",
  "reference": null,
  "amount": 10,
  "currency": "EUR",
  "customer": {
    "firstName": "Bau",
    "lastName": "Mas",
    "email": "v.ivanovas@gmail.com",
    "phone": "370 66666666",
    "ipaddress": null,
    "referenceId": null
  },
  "billingAddress": {
    "address1": "211, Victory street",
    "city": "Vilnius",
    "countryCode": "LT",
    "postalCode": "01001",
    "state": "LT"
  }
}

GOOGLEPAY

{
  "id": "019bebd8-75ce-7ebb-8049-e4e9bda33320",
  "paymentStatus": "COMPLETED",
  "created": {
    "date": "2026-01-23 19:13:11.000000",
    "timezone_type": 3,
    "timezone": "Europe/Vilnius"
  },
  "paymentType": "DEPOSIT",
  "description": "Test payment",
  "paymentMethod": "GOOGLEPAY",
  "reference": "97f405f850a94f5cba5a7aeef1398dc6",
  "amount": 20.0,
  "currency": "EUR",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@gmail.com",
    "phone": "37061111111",
    "ipaddress": "2a0a:a547:a0fe:0:94b2:60f0:adb8:d753",
    "dateOfBirth": null,
    "referenceId": "761181"
  },
  "billingAddress": {
    "address1": "211, Victory street",
    "city": "Vilnius",
    "countryCode": "LT",
    "postalCode": "01001",
    "state": "LT"
  },
  "fallbackPaymentStatus": 1
}

APPLEPAY

{
  "id": "019bebd4-5b04-7016-8a50-b918fca777c5",
  "paymentStatus": "COMPLETED",
  "created": {
    "date": "2026-01-23 19:08:41.000000",
    "timezone_type": 3,
    "timezone": "Europe/Vilnius"
  },
  "paymentType": "DEPOSIT",
  "description": "Test payment",
  "paymentMethod": "APPLEPAY",
  "reference": "ce43f23650994ae7896ad31433992a53",
  "amount": 100.0,
  "currency": "EUR",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@icloud.com",
    "phone": "37061111111",
    "ipaddress": "11.11.11.11",
    "dateOfBirth": null,
    "referenceId": "553448"
  },
  "billingAddress": {
    "address1": "211, Victory street",
    "city": "Vilnius",
    "countryCode": "LT",
    "postalCode": "01001",
    "state": "LT"
  }
}

BLIK

{
  "id": "019bebb4-5d6b-7c89-ae10-05b06d2b89d9",
  "paymentStatus": "COMPLETED",
  "created": {
    "date": "2026-01-23 18:33:50.000000",
    "timezone_type": 3,
    "timezone": "Europe/Vilnius"
  },
  "paymentType": "DEPOSIT",
  "description": "Test payment",
  "paymentMethod": "BLIK",
  "reference": "0f6632f4f62d4c42a1a08eed53ddfa77",
  "amount": 50.0,
  "currency": "PLN",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@wp.pl",
    "phone": "48111111111",
    "ipaddress": "11.11.11.11",
    "dateOfBirth": null,
    "referenceId": "1255509"
  },
  "billingAddress": {
    "address1": "211, Victory street",
    "city": "Vilnius",
    "countryCode": "LT",
    "postalCode": "01001",
    "state": null
  }
}

API request response scheme

Bodyapplication/json
idstring
paymentStatusstring
Enum"PENDING""AUTHORIZED""COMPLETED""FAILED""CANCELED"
createdobject
paymentTypestring
Value"DEPOSIT"
descriptionstring or null
paymentMethodstring
Enum"APPLEPAY""GOOGLEPAY""BLIK""CARD""ONRAMP""ONRAMP_PAYID""ONRAMP_PIX""ONRAMP_ZAR""ONRAMP_PSE""ONRAMP_KHIPU"
Discriminator
referencestring or null
amountnumber(float)
currencystring
customerobject(CustomerInfo)

Customer information (all fields optional unless specified by method).

billingAddressobject(BillingAddress)

Billing address (fields optional unless required by method).

Response
application/json
{
  "id": "01990efa-5437-70c6-8244-85546f382bb3",
  "paymentStatus": "PENDING",
  "created": {
    "date": "2025-09-03 12:48:31.020712",
    "timezone_type": 3,
    "timezone": "Europe/Vilnius"
  },
  "paymentType": "DEPOSIT",
  "description": "Test ApplePay payment for order order-45c721ca",
  "paymentMethod": "APPLEPAY",
  "reference": "order-45c721ca",
  "amount": 10.23,
  "currency": "EUR",
  "customer": null,
  "billingAddress": {
    "address1": null,
    "city": null,
    "countryCode": "GB",
    "postalCode": null,
    "state": null
  }
}