# Create a transaction

**POST /merchant/{merchantId}/transaction**

In accordance with PCI DSS requirements (set by payment organizations), processing, transmitting, or storing card numbers and other card data is prohibited.
If you have a valid PCI DSS certificate and want to provide a card payment form on your store website - please contact Axepta support.
If you redirect directly to the Axepta card payment form, this is not required.



## 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)

- **type** (string)
  Transaction type. Allowed values: sale

- **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)
  Transaction title; allowed characters: A-Za-z0-9#&_-"',./ plus space (0x20) and UNICODE range 00C0 - 02C0 (incl. Polish diacritics)

- **paymentMethod** (string)
  Method used to process the order. More information in section [1.4 Transaction methods and channels]

- **paymentMethodChannel** (string)
  Payment channel designation. More information in section [1.4 Transaction methods and channels]

- **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

- **returnUrl** (string(uri))
  Default return URL.

- **clientIp** (string(ipv4, ipv6))
  The payer's real IP address provided in `IPv4` or `IPv6`. Required when providing [blikCode](#operation-post-parameter-transaction-body-application-json-blikCode).

- **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.

- **blikCode** (integer)
  BLIK code value for transactions where the code is provided via API.

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

- **customer** (object)

- **card** (object)
  Card payment data. (Required for card payments)

- **additionalData** (object)
  Payer browser information required when performing card payments with 3DS authorization.



## Responses

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