# 5.1. HTTP Request

### Example address to which the POST request should be sent

```
https://api.axepta.pl/v1/merchant/6yt3gjtm9p7b8h9xsdqz/payment-link
```

### Request payload

```json
{
  "serviceId": "62f574ed-d4ad-4a7e-9981-89ed7284aaba",
  "amount": 1000,
  "currency": "PLN",
  "orderId": "139",
  "successReturnUrl": "https://domain.com/success",
  "failureReturnUrl": "https://domain.com/failure",
  "customer": {
      "firstName": "Jan",
      "lastName": "Kowalski",
      "email": "jan.kowalski@example.com"
    }
}
```

### Payload parameters

| Parameter            | Type                    | Required | Description |
|---------------------|-------------------------|----------|-------------|
| `serviceId`         | string(36)              | ✔️       | store identifier as UUID v4. |
| `amount`            | integer(1-999999999)    | ✔️       | Transaction amount in the smallest currency unit, e.g. grosz. |
| `currency`          | string(3)               | ✔️       | Transaction currency in ISO 4217 format. |
| `orderID`           | string(100)             | ✔️       | Merchant order number, <br> **allowed characters**: A-Za-z0-9#_-.\/ as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters) |
| `title`             | string(255)             | -        | Order title, <br> **allowed characters**: A-Za-z0-9#&_-"',.\/ as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters) |
| `returnUrl`         | string(300)             | -        | Return address from the external payment handling page in the event the transaction status remains unresolved. |
| `successReturnUrl`  | string(300)             | -        | Return address from the external payment handling page when the payment is completed successfully. |
| `failureReturnUrl`  | string(300)             | -        | Return address from the external payment handling page when a payment error occurs. |
| `customer`          | object                  | ✔️       | Customer data. |
| `activeTo`          | integer, null           | -        | Transaction expiration date as a Unix timestamp in seconds (time measured in seconds since the start of 1970 UTC) <br>(**the value must be greater than or equal to 1 and less than or equal to 4294967295**). If it is not passed or is null, the transaction is always valid. Failure to complete the payment by that time will result in its cancellation. |
| `paywall.forceCardChannel` | string          | -        | Forces the card payment mode. Allows card payment initialization in card profile saving mode. <br> **Available values:** `ecom3ds`, `oneclick`, `recurring`. When using `oneclick` or `recurring`, the `customer.cid` parameter is required. |
| `distributor`       | string                  | -        | Distributor name, allowed value: "shoper". |
| `visibleMethod`     | array                   | -        | Visibility of payment methods; by default all methods available for the store are visible. Description in point 5.3 |
| `surcharge`         | boolean                 | -        | Flag determining whether payer surcharge will be used for the given order. Allowed values: 'true', 'false' (the surcharge flag must be enabled during the onboarding process). |

Parameters for `customer`:

| Parameter    | Type         | Required | Description |
|-------------|--------------|----------|-------------|
| `firstName` | string(100)  | ✔️       | Customer first name, <br> **allowed characters**: A-Za-z0-9#&_-"',.\/ as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters) |
| `lastName`  | string(100)  | ✔️       | Customer last name, <br> **allowed characters**: A-Za-z0-9#&_-"',.\/ as well as the space character (0x20) and characters in the UNICODE range 00C0 - 02C0 (including Polish diacritical characters) |
| `email`     | string(200)  | ✔️       | E-mail address. |
| `phone`     | string(20)   | -        | Phone number, <br> **allowed characters**: 0-9+- and the space character (0x20). |
| `cid`       | string(36)   | -        | Customer/payer identifier assigned by the merchant. (Required for oneclick and recurring payments),<br> **allowed characters**: A-Za-z0-9 and hyphen (0x2D) |