ACI Payments API (1.0.0)

Indicates the amount of the payment request. The dot is used as decimal separator. The amount is the only amount value which is processing relevant. All other amount declarations like taxAmount or shipping.cost are already included. Format: N10.N2

Indicates the tax amount of the payment request. The dot is used as decimal separator. Format: N10.N2

L3 Card data invoice level discount amount Format: N10.N2

The currency code of the payment request's amount (ISO 4217). Format: A3

The brand specifies the method of payment for the request. This is optional if you want to use brand detection for credit cards, if not then it is mandatory. Format: AN32

The payment type for the request. You can send payment requests with one of the following types:

• PA, Preauthorization: A stand-alone authorisation that will also trigger optional risk management and validation. A Capture (CP) with reference to the Preauthorisation (PA) will confirm the payment..
• DB, Debit: Debits the account of the end customer and credits the merchant account.
• CD, Credit: Credits the account of the end customer and debits the merchant account.
• CP, Capture: Captures a preauthorized (PA) amount.
• RV, Reversal: Reverses an already processed Preauthorization (PA), Debit (DB) or Credit (CD) transaction. As a consequence, the end customer will never see any booking on his statement. A Reversal is only possible until a connector specific cut-off time. Some connectors don't support Reversals.
• RF, Refund: Credits the account of the end customer with a reference to a prior Debit (DB) or Credit (CD) transaction. The end customer will always see two bookings on his statement. Some connectors do not support Refunds. Format: A2

If true, the SRI hash of the payment script will be calculated and returned in the response. This is needed to allow the browser to check the integrity of the script in accordance with PCI requirements. For more information refer to Scripts compliance page Format: A5

Override the payment type for specific brands, e.g. overridePaymentType[KLARNA_INVOICE]=PA. Only accepted during checkout creation.

Can be used to populate all or part of the Merchant Name descriptor, which often appears on the first line of the shopper's statement. The full use of this field depends on the Merchant Account configuration. NOTE: merchant.name can override any data sent in this field. Format: AN127

Merchant-provided reference number, should be unique for your transactions. Some receivers require this ID. This identifier is often used for reconciliation. Format: AN255

Merchant-provided invoice number, should be unique for your transactions. This identifier is not sent onwards. Format: AN255

Merchant-provided additional information. The information provided is not transaction processing relevant. It will appear in reporting only. Format: AN255

The category of the transaction, possible values are:

• EC - eCommerce
• MO - Mail order
• TO - Telephone order
• PO - pos
• PM - mpos
• MOTO - Mail order Telephone order Format: AN32

Additional field sent by Merchant to indicate last transaction for CP, RV, RF etc. sequence=FINAL indicates this is the last transaction.

Sets the maximum number of possible partial Captures. The numberOfCaptures parameter is supported only when the Preauthorization (PA) request creates a new registration. If a PA request references an existing registration, the numberOfCaptures parameter is not supported and the request will be rejected. Format: N2

Discount code applied at the Order level. There will be 1 Promotion Code per order. Format: AN15

Sets the language/country. Examples : "de-AT", "en-US". etc Note: Check the requirements of the connector you are integrating in your shop to understand which language/country that connector supports. Format: AN10

Visa AFT and Visa OCT transactions destined for recipients in the countries Argentina, Bangladesh, Chile, Colombia, Egypt, and India, must include this field. Purpose of payment codes can be entered according to the regulatory or country requirements of the recipient issuer. Format: AN12

Integration Type Format: AN10

Used for Visa Direct (AFT and OCT) Business Application ID Format: AN2

Used for Mastercard Send (Funding and Payment) Transaction Type Identifier Format: AN3

Used to flag the type of transaction. PURCHASE - default value, used for regular purchase transactions. FUNDING - used for Visa AFT or Mastercard funding transactions. PAYMENT - used for Visa OCT or Mastercard payment transactions. PURCHASE| FUNDING| PAYMENT

Lifecycle Id Used by Mastercard to enable consistent linking of the original authorization with subsequent lifecycle related transactions through the Transaction Link Identifier (TLID) (for example, incremental authorizations, reversals, and captures). Format: AN35

The referenceUuid parameter provides a parameterized alternative for referencing an existing transaction by its UUID within a payment request on /v1/payments, instead of using the endpoint‑based reference /v1/payments/{UUID}. When provided, the platform validates the UUID and links the new request to the original payment authorization; if no matching transaction is found, the request fails with a validation error. This parameter is used for REAUTHORIZATION and INCREMENTAL_AUTH. Format: AN32

The due date of the transaction of the direct debit. AN10 {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}

If true, the payment details will be stored with the request. As part of the response, you will receive the parameter registration.id which you can use to reference the registration for later payments. Format: A5

If true, it allows to send in the card.holder or bankAccount.holder to override the empty holder from the registration/tokenization transaction. It applies only to that particular payment and does not change the holder value of the registration transaction. For one-click payment, the edit box appears as the replacement over the empty label to allow the user to input the new value for the holder. This parameter is available on prepare (and update) checkout step of as well as when sending the payment over registration one-click payment Server-to-Server. Format: A5

This URL will receive the result of an asynchronous payment. It is used to redirect the shopper to the merchant’s website or application. Must be sent URL encoded and only absolute URLs are supported. Format: AN2048

Deprecated. Please follow webhooks configuration and don’t use the request parameter “notificationUrl”. Due to the huge variety of payment workflows and checkout options, the notificationUrl parameter is not fully compatible with all activities. Please use webhook notifications instead. This URL will receive the asynchronous notification where applicable. It is used to receive the transaction status update on asynchronous payments. Must be sent URL encoded. . Format: AN2048

The chargeback reason code for the chargeback as received separately from the acquirer. See the chargeback result codes for more detailed information.

The unique identifier for the entity making the request. This is an API-level field used for authentication. Format: AN32

The transaction ID assigned by the merchant for this transaction. Format: AN40

The transaction ID assigned by the scheme for this transaction. Format: AN60

Extended issuer information derived from BIN data (e.g., issuer name and country). Object

Additional payment details for bank-to-bank transactions (e.g., payment reference, destination account). Object

The transaction category. Allowed values: ACH, BPY, EC, IN, MO, RP, TO, PO, PM, MOTO, VN String (enum)

A more descriptive, human‑readable category (e.g., akin to an MCC). Format: AN32

The payment type for the request. Allowed values: AV, CD, CP, DB, PA, PY, RF, RV, TR String (enum)

The transaction amount as a string. amountString

ISO 4217 alphabetic currency code. currencyCodeAlpha

The date and time the transaction was authorized (RFC 3339), expected UTC. date-time (RFC 3339)

Response code from the card authorizer (typically 2 characters). Format: AN2

Brand of the payment card (e.g., Visa, Mastercard, Amex). Format: AN32