---
title: "Pre-Authorization - APM"
method: POST
path: "/pay/backoffice/payment_preauthorize"
---

# Pre-Authorization - APM

`POST /pay/backoffice/payment_preauthorize`

## Request body

- object
  - `merchantid` string, required — The merchant identification number issued during account creation.
  - `orderid` string — max 40 characters. The field orderid is optional and exclusively for the merchants convenience.
  - `amount` number, double, required — The amount field contains the transaction’s total amount. This is the amount that will be transmitted to the authorizing system.
  - `currency` string, required — The currency field contains the alphanumeric currency code for the transaction, according to ISO 4217, e.g. EUR, USD, AUD, CAD, NOK, SEK, CHF. to http://www.xe.com/iso4217.php
  - `payment_method` integer, required — Valid payment method id, e.g. 17 = Sofort
  - `signature` string, required — The signature field contains a 40-figure hexadecimal value. This signature value is a checksum designed to protect the merchant account from unauthorized access.
  - `url_success` string — The customer will be redirected to url_success, if transaction successful.
  - `url_failed` string — The customer will be redirected to url_failed, if transaction failed.
  - `notification_url` string — This parameter can be used to override the account notification url setup on our system.
  - `language` string — The language in which the error messages will be displayed. Default value en or de. ISO-639-1 alpha 2
  - `external_id` string — 255 characters. Merchant’s unique id, internal comment
  - `salutation` string — Salutation. Mr., Mrs.
  - `title` string — Title. Dr., Prof.
  - `gender` string — Gender. M – male F – female
  - `firstname` string — First name
  - `lastname` string — Last name
  - `birthday` string — The customer's birthday
  - `street` string — Street of the customer's address.
  - `house` string — The house number of the customer.
  - `postbox` string — Post office box
  - `zip` string — The customer's postal code (USA and Canada only)
  - `city` string — The customer's city
  - `state` string — The state/province (USA and Canada only)
  - `country` string — The country of customer. ISO 3166 alpha3 format only
  - `email` string, required — A RFC 822 compliant email address
  - `phone` string — The customer's phone number. Only numbers
  - `fax` string — The customer's phone number
  - `mobile` string — The mobile number of the customer
  - `company` string — The company
  - `customerid` string — An internal customer id in the merchant’s shop system
  - `customerip` string — The customer's IP address
  - `custom1` string — The custom field for the merchant
  - `custom2` string — The custom field for the merchant
  - `custom3` string — The custom field for the merchant
  - `shipping_country_code` string — 3 characters, ISO 3166-1. Used for PayPal
  - `shipping_state` string — max 3 characters. ISO 3166-2. Used for PayPal
  - `shipping_address_line_1` string — max 50 characters. Used for PayPal
  - `shipping_address_line_2` string — max 50 characters. Used for PayPal
  - `shipping_postal_code` string — max 16 characters. Used for PayPal
  - `shipping_first_name` string — max 150 characters. Used for PayPal
  - `shipping_last_name` string — max 150 characters. Used for PayPal
  - `shop_url` string — max 255 characters starting with http or https. Used when several websites are used on 1 account

## Response `200`

200

## Other responses

- `400` — 400

---

[API](https://skmtc.net/payabl/apis/payabl-gateway-api.md) · [All operations](https://skmtc.net/payabl/apis/payabl-gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payabl/payabl-gateway-api/versions/30238a690005/schema)