# Create a payment link order

**POST /merchant/{merchantId}/payment-link**




## Servers
- Production server.: https://api.axepta.pl/v1 (Production server.)
- Sandbox - test server.: https://api.sandbox.axepta.pl/v1 (Sandbox - test server.)


## Authentication methods
- Authorization token


## Parameters

### Path parameters

- **merchantId** (string)
  Client identifier



### Body: application/json (object)

- **serviceId** (string(uuid))
  Store identifier as `UUID v4`

- **amount** (integer)
  Transaction amount in the smallest currency unit, e.g. **grosz**

- **currency** (string)
  Transaction currency in `ISO 4217` format

- **orderId** (string)
  Merchant order number,
  **allowed characters**: A-Za-z0-9#_-.\/ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics)

- **title** (string)
  Order title, allowed characters: A-Za-z0-9#&_-"',./ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics).

- **customer** (object)

- **returnUrl** (string(uri))
  Return URL from the external payment page if the transaction status is not resolved

- **successReturnUrl** (string(uri))
  Return URL from the external payment page after a successful payment

- **failureReturnUrl** (string(uri))
  Return URL from the external payment page in case of a payment error

- **visibleMethod** (array)
  Visibility of payment methods; by default, all methods available for the store are visible.
  [Description in section 5.3 Payment methods visibility](https://bump.sh/pgw/doc/axepta-api/topic/topic-5-3-widocznosc-metod-platnosci)

- **paywall.forceCardChannel** (string)
  Force card payment mode. Allows initializing a card payment in profile-saving mode.
  Available values: ecom3ds, oneclick, recurring. When using oneclick or recurring, customer.cid is required.

- **activeTo** (integer, null)
  Transaction expiration date as a Unix timestamp in seconds (seconds since 1970-01-01 UTC)
  (value must be >= 1 and <= 4294967295). If not provided or null, the transaction is valid indefinitely.
  Not completing the payment by this time will cancel it.

- **distributor** (string)
  Distributor name, allowed value: "shoper".

- **surcharge** (boolean)
  Flag determining whether payer charging will be used for the given order.
  Allowed values: 'true', 'false' (requires surcharge flag enabled during onboarding).



## Responses

[Powered by Bump.sh](https://bump.sh)