Skip to content

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 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"
Example: "APPLEPAY"
Discriminator
amountnumber(float)> 0required
Example: 10.99
currencystringrequired
Example: "EUR"
externalApiIdstring or null
Example: "order-123456"
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
Example: "Test payment"
referencestring or null
Example: "Reference 123"
webhookUrlstring or nullrequired
Example: "https://example.com/callback"
returnUrlstring or nullrequired
Example: "https://example.com/return"
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

Bodyapplication/json
idstring
Example: "0198d10e-9bcf-71ec-af66-50fa170e607a"
paymentStatusstring
Enum"PENDING""AUTHORIZED""COMPLETED""FAILED""CANCELED"
Example: "COMPLETED"
createdobject
paymentTypestring
Value"DEPOSIT"
Example: "DEPOSIT"
descriptionstring or null
Example: "Test payment"
paymentMethodstring
Enum"APPLEPAY""GOOGLEPAY""BLIK""CARD""ONRAMP""ONRAMP_PAYID""ONRAMP_PIX""ONRAMP_ZAR""ONRAMP_PSE""ONRAMP_KHIPU"
Discriminator
referencestring
Example: "order-62e55adf"
amountnumber(float)
Example: 10.23
currencystring
Example: "EUR"
customerobject(CustomerInfo)

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

billingAddressobject(BillingAddress)

Billing address (fields optional unless required by method).

walletDetailsobject

Apple Pay–specific details

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