Payments (Private)

Process credit top-up payments and check payment status. Integrates with the Barion payment gateway for secure payment processing. Requires Private API (Bearer token) authentication.

Get payment status

GET

https://api.chameleoon.sk

/private/payments/{paymentId}

Returns the current status of a payment.

Get payment status › path Parameters

paymentId

string · uuid · required

Unique payment identifier

Get payment status › Responses

Payment status

Payment status information

PaymentStatusDto

paymentId

string · uuid · required

Unique payment identifier

status

string · enum · required

Current payment processing status

Enum values:

pending

in_progress

paid

error

refunded

amount

number · decimal · required

Payment amount that was charged or will be charged

currency

string · pattern: ^[A-Z]{3}$ · required

ISO 4217 three-letter currency code for the payment (e.g., "EUR", "CZK")

timestamp

string · date-time · required

Timestamp of the most recent payment status change (format yyyy-MM-ddTHH:mm:ss.fff)

Add credit

POST

https://api.chameleoon.sk

/private/payments/credit

Creates a new payment to add credit to an account's balance. Returns a payment gateway URL for the user to complete the payment.

Payment Notifications

If notificationUrl is provided, the system will send HTTP POST requests to that URL whenever the payment status changes.

Notification Behavior:

HTTP Method: POST
Content-Type: application/json
Triggered on every payment status change
Timeout: 10 seconds
Retry Policy: 3 attempts with intervals of 5s, 20s, 60s on failure

Security Recommendation:

The notificationUrl should use HTTPS to ensure secure transmission
Receivers should verify the payment status by calling GET /private/payments/{paymentId} endpoint

Example Notification Payload:


Code
{
  "paymentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "Paid",
  "amount": 100.00,
  "currency": "EUR",
  "timestamp": "2025-09-01T08:00:00.000"
}

Add credit › Request Body

Request to create a payment

CreatePaymentRequestDto

accountId

string · uuid · required

Account identifier to charge

amount

number · decimal · min: 1 · required

Credit amount to add to the account balance (minimum 1)

currency

string · enum · required

Payment currency. Only "EUR" is supported.

Enum values:

EUR

redirectUrl

string · uri · required

URL to redirect user after payment

allowRecurringPayment

boolean

Whether to enable recurring payments

Default: false

balanceBelowTrigger

number · decimal

Auto-charge when balance drops below this amount

notificationUrl

string · uri

URL where a POST request will be sent when payment status changes. Must use HTTPS protocol.

Add credit › Responses

Payment created successfully

Payment creation result

PaymentResponseDto

paymentId

string · uuid · required

Unique payment identifier

paymentGatewayUrl

string · uri · required

URL to redirect user to payment gateway

POST/private/payments/credit

curl https://api.chameleoon.sk/private/payments/credit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "accountId": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "amount": 100,
  "currency": "EUR",
  "redirectUrl": "https://example.com/payment/callback",
  "allowRecurringPayment": false,
  "balanceBelowTrigger": 10,
  "notificationUrl": "https://example.com/payment/notifications"
}'

Example Request Body

{
  "accountId": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "amount": 100,
  "currency": "EUR",
  "redirectUrl": "https://example.com/payment/callback",
  "allowRecurringPayment": false,
  "balanceBelowTrigger": 10,
  "notificationUrl": "https://example.com/payment/notifications"
}

json

Example Responses

{
  "paymentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "paymentGatewayUrl": "https://gateway.barion.com/v2/pay?id=abc123def456"
}

json

application/json

Invoices (Private)Parcel Shops (Private)

Chameleoon API v2

Payments (Private)

Process credit top-up payments and check payment status. Integrates with the Barion payment gateway for secure payment processing. Requires Private API (Bearer token) authentication.

Get payment status

GET

https://api.chameleoon.sk

/private/payments/{paymentId}

Returns the current status of a payment.

Get payment status › path Parameters

paymentId

string · uuid · required

Unique payment identifier

Get payment status › Responses

Payment status

Payment status information

PaymentStatusDto

paymentId

string · uuid · required

Unique payment identifier

status

string · enum · required

Current payment processing status

Enum values:

pending

in_progress

paid

error

refunded

amount

number · decimal · required

Payment amount that was charged or will be charged

currency

string · pattern: ^[A-Z]{3}$ · required

ISO 4217 three-letter currency code for the payment (e.g., "EUR", "CZK")

timestamp

string · date-time · required

Timestamp of the most recent payment status change (format yyyy-MM-ddTHH:mm:ss.fff)

Add credit

POST

https://api.chameleoon.sk

/private/payments/credit

Creates a new payment to add credit to an account's balance. Returns a payment gateway URL for the user to complete the payment.

Payment Notifications

If notificationUrl is provided, the system will send HTTP POST requests to that URL whenever the payment status changes.

Notification Behavior:

HTTP Method: POST
Content-Type: application/json
Triggered on every payment status change
Timeout: 10 seconds
Retry Policy: 3 attempts with intervals of 5s, 20s, 60s on failure

Security Recommendation:

The notificationUrl should use HTTPS to ensure secure transmission
Receivers should verify the payment status by calling GET /private/payments/{paymentId} endpoint

Example Notification Payload:


Code
{
  "paymentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "Paid",
  "amount": 100.00,
  "currency": "EUR",
  "timestamp": "2025-09-01T08:00:00.000"
}

Add credit › Request Body

Request to create a payment

CreatePaymentRequestDto

accountId

string · uuid · required

Account identifier to charge

amount

number · decimal · min: 1 · required

Credit amount to add to the account balance (minimum 1)

currency

string · enum · required

Payment currency. Only "EUR" is supported.

Enum values:

EUR

redirectUrl

string · uri · required

URL to redirect user after payment

allowRecurringPayment

boolean

Whether to enable recurring payments

Default: false

balanceBelowTrigger

number · decimal

Auto-charge when balance drops below this amount

notificationUrl

string · uri

URL where a POST request will be sent when payment status changes. Must use HTTPS protocol.

Add credit › Responses

Payment created successfully

Payment creation result

PaymentResponseDto

paymentId

string · uuid · required

Unique payment identifier

paymentGatewayUrl

string · uri · required

URL to redirect user to payment gateway

POST/private/payments/credit

curl https://api.chameleoon.sk/private/payments/credit \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "accountId": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "amount": 100,
  "currency": "EUR",
  "redirectUrl": "https://example.com/payment/callback",
  "allowRecurringPayment": false,
  "balanceBelowTrigger": 10,
  "notificationUrl": "https://example.com/payment/notifications"
}'

Example Request Body

{
  "accountId": "e5b357eb-837d-41c0-82c8-663b8399ff47",
  "amount": 100,
  "currency": "EUR",
  "redirectUrl": "https://example.com/payment/callback",
  "allowRecurringPayment": false,
  "balanceBelowTrigger": 10,
  "notificationUrl": "https://example.com/payment/notifications"
}

json

Example Responses

{
  "paymentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "paymentGatewayUrl": "https://gateway.barion.com/v2/pay?id=abc123def456"
}

json

application/json

Invoices (Private)Parcel Shops (Private)