Skip to content

Apple Pay Alternative

SS Integration option

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends the payment request to Freepayment.
  3. Freepayment sends a response containing the URL for completing the payment.
  4. The merchant redirects the customer to the provided URL.
  5. The customer completes the payment.
  6. Freepayment sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Freepayment with the status query. If the transaction was successful, the webhook notification and the response to the status query may additionally contain apple_pay_alt.account_number parameter with the card mask value.

Info

This integration option supports only EUR currency.

Payment

Request

Send a payment request with the following additional parameters:

object
return_url
required
string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required
string
apple_pay_alt.
Request example
{
  "request": {
    "amount": 444,
    "currency": "EUR",
    "description": "test description",
    "test": false,
    "tracking_id": "your_uniq_number21212",
    "ip": "127.0.0.1",    
    "return_url": "https://your-success.url",
    "method": {
      "type": "apple_pay_alt"
    }
  }
}
Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example
{
  "transaction": {
    "uid": "cd7f3e9e-3484-407b-a880-b70d9906a0e3",
    "type": "payment",
    "status": "pending",
    "amount": 444,
    "currency": "EUR",
    "description": "test description",
    "created_at": "2025-07-01T07:21:34Z",
    "updated_at": "2025-07-01T07:21:34Z",
    "method_type": "apple_pay_alt",
    "receipt_url": "https://backoffice.stelixor.io/customer/transactions/cd7f3e9e-3484-407b-a880-b70d9906a0e3/2c5248b0087d16eb66dfca89c2f8f22f3d762660576096dcab8d956133ac9bf4?language=en",
    "payment": {
      "status": "pending",
      "gateway_id": 5527,
      "ref_id": "951599511",
      "message": "Invoice is created successfully, waiting for a payment",
      "bank_code": 31,
      "rrn": 8888,
      "auth_code": 9999
    },
    "apple_pay_alt": {
      "type": "apple_pay_alt"
    },
    "customer": {
      "email": null,
      "ip": "127.0.0.1"
    },
    "manually_corrected_at": null,
    "version": 1,
    "message": "Invoice is created successfully, waiting for a payment",
    "tracking_id": "your_uniq_number21212",
    "test": false,
    "language": "en",
    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },    
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "payment-link",
      "fields": [],
      "method": "GET"
    }
  }
}  

Refund

Request

Send a standard refund request. The amount value must equal the amount of the corresponding payment transaction.

JF Integration option

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends the payment request to Freepayment.
  3. Freepayment sends a response containing the URL for completing the payment.
  4. The merchant redirects the customer to the provided URL.
  5. The customer completes the payment.
  6. Freepayment sends a webhook notification with the payment status to the merchant. The merchant may also request the payment status from Freepayment with the status query.

Info

This integration option supports only EUR currency.

Payment

Request

Send a payment request with the following additional parameters:

object
return_url
required
string
A URL to return the customer to when a transaction is completed.
object
A section of the payment method.
type
required
string
apple_pay_alt.
Request example
{
  "request": {
    "amount": 12789,
    "currency": "EUR",
    "description": "Description",
    "test": false,
    "tracking_id": "123",
    "skip_duplicate_check": true,
    "ip": "127.0.0.1",
    "language": "en",
    "notification_url": "https://website/notification",
    "return_url": "https://test.com",

    "method": {
      "type": "apple_pay_alt"
    }
  }
}
Response

Redirect your customer to the URL received as the value of the form.action parameter.

Response example
{
  "transaction": {
    "uid": "270fec3d-a458-4017-9002-7854956522a3",
    "type": "payment",
    "status": "pending",
    "amount": 12789,
    "currency": "EUR",
    "description": "Description",
    "created_at": "2026-05-19T12:42:35Z",
    "updated_at": "2026-05-19T12:42:35Z",
    "method_type": "apple_pay_alt",
    "receipt_url": "https://backoffice.stelixor.io/customer/transactions/270fec3d-a458-4017-9002-7854956522a3/e9f0567d31b61e3d4419dd93919bbab3c1a87fa138d860013012e275532326b6?language=en",
    "payment": {
      "status": "pending",
      "gateway_id": 6587,
      "ref_id": "480263362584145",
      "message": "Transaction was initialized."
    },
    "apple_pay_alt": {
      "type": "apple_pay_alt"
    },
    "customer": {
      "email": null,
      "ip": "127.0.0.1"
    },
    "manually_corrected_at": null,
    "version": 1,
    "message": "Transaction was initialized.",
    "tracking_id": "123",
    "test": false,
    "language": "en",

    "additional_data": {
      "payment_method": {
        "type": "alternative"
      }
    },
    "smart_routing_verification": {
      "status": "successful"
    },
    "gateway": {
      "iframe": false
    },
    "form": {
      "action": "link-to-payment-page",
      "fields": [],
      "method": "GET"
    }
  }
}  

Refund

Request

For the refund, send a refund request with the UID of the payment transaction. The refund can be executed once for an amount less than or equal to the parent transaction amount.

MF Integration option

Payment

Payment flow

  1. The customer initiates the payment on the merchant's website.
  2. The merchant sends a payment request to Freepayment with method.type set to apple_pay_alt.
  3. Freepayment responds with the payment page URL in redirect_url.
  4. The merchant redirects the customer to that URL. The customer selects Apple Pay and confirms the payment.
  5. Freepayment sends a webhook notification with the final payment status. The merchant may also use the status query.

Info

Available currencies depend on the gateway configuration. The default settings include EUR, GBP, and PLN.

Request

Send a payment request with the following data:

object
amount
required
bigInteger
Transaction amount in minimal currency units, for example, 1000 (10 units of the selected currency).
currency
required
string (3)
Transaction currency in the ISO 4217 alpha-3 format.
description
required
string (512)
Short description of the order.
return_url
required
string
URL to return the customer to when a transaction is completed.
ip
string
Customer's IP address.
language
string (2)
Customer's language.
object
Section of the payment method.
type
required
string
apple_pay_alt.
object
Section of information about the customer.
first_name
required
string (60)
Customer's first name.
last_name
required
string (60)
Customer's last name.
email
required
string
Customer's email address.
external_id
string (128)
Customer's identifier in the merchant's system.
birth_date
string
Customer's date of birth in the ISO 8601 format (YYYY-MM-DD).
phone
string (18)
Customer's phone number including the country code.
country
required
string (2)
Customer's billing country in the ISO 3166-1 alpha-2 format.
address
required
string (300)
Customer's billing address.
city
required
string (50)
Customer's city.
state
string (40)
Customer's billing state or region.
zip
required
string (12)
Customer's billing ZIP or postal code.
Request example
{
    "request": {
        "amount": 1000,
        "currency": "EUR",
        "description": "Order 1234",
        "return_url": "https://example.com/return",
        "ip": "203.0.113.10",
        "language": "en",
        "method": {
            "type": "apple_pay_alt"
        },
        "customer": {
            "first_name": "Joan",
            "last_name": "Collins",
            "email": "joan@example.com",
            "external_id": "customer-1234",
            "birth_date": "1990-05-14",
            "phone": "+447700900123",
            "country": "GB",
            "address": "10 Downing Street",
            "city": "London",
            "zip": "SW1A 1AA"
        }
    }
}
Response

Redirect the customer to the URL in redirect_url. A redirect to the merchant's site does not confirm the payment status; use the webhook notification or status query for the result.

Response example
{
    "transaction": {
        "uid": "8b58d761-cea0-484b-9509-9c07d38569b8",
        "type": "payment",
        "status": "pending",
        "amount": 1000,
        "currency": "EUR",
        "description": "Order 1234",
        "created_at": "2026-10-21T13:38:32Z",
        "updated_at": "2026-10-21T13:38:33Z",
        "method_type": "apple_pay_alt",
        "receipt_url": "https://backoffice.stelixor.io/customer/transactions/8b58d761-cea0-484b-9509-9c07d38569b8/283251d7fa6c5fe98d593752ca41b3a84e5525dc1433c801673465fbab960946?language=en",
        "payment": {
            "status": "pending",
            "gateway_id": 6749,
            "ref_id": "a338ffaaff3f44cb8715e7d127a3b1d9",
            "message": "Transaction was initialized."
        },
        "apple_pay_alt": {
            "type": "apple_pay_alt"
        },
        "customer": {
            "zip": "SW1A 1AA",
            "city": "London",
            "email": "joan@example.com",
            "phone": "+447700900123",
            "address": "10 Downing Street",
            "country": "GB",
            "last_name": "Collins",
            "birth_date": "1990-05-14",
            "first_name": "Joan",
            "external_id": "customer-1234",
            "ip": "203.0.113.10"
        },
        "manually_corrected_at": null,
        "version": 2,
        "message": "Transaction was initialized.",
        "test": false,
        "language": "en",
        "billing_address": {
            "zip": "SW1A 1AA",
            "city": "London",
            "email": "joan@example.com",
            "phone": "+447700900123",
            "address": "10 Downing Street",
            "country": "GB",
            "last_name": "Collins",
            "birth_date": "1990-05-14",
            "first_name": "Joan"
        },
        "additional_data": {
            "payment_method": {
                "type": "alternative"
            }
        },
        "smart_routing_verification": {
            "status": "successful"
        },
        "gateway": {
            "iframe": false
        },
        "form": {
            "action": "link-to-payment-page",
            "fields": [],
            "method": "GET"
        }
    }
}

Refund

Request

Send a standard refund request. The amount value must equal the amount of the corresponding payment transaction. Only one full refund is supported for each payment transaction.