Authorisations File

Overview

Context — All authorisations for all merchants on a given day. File Type — CSV File Name — <company_name>_authorisations_YYYYMMDDHHmmSS

Example: <company_name>_authorisations_20221110233030
company_name = your company’s name

Frequency — Daily

Data Columns

The following table provides the column definitions for the authorisation data. Each row represents an authorisation request by a merchant. An authorisation is the process by which a card issuer or payment network (such as Visa or Mastercard) approves or declines a transaction based on factors like available funds, fraud detection, and cardholder status. All authorisations — approved, rejected, or cancelled — must be included.

Column	Type	Required	Description
`environment`	enum	Mandatory	Environment to which the authorisation belongs. Allowed: `PRODUCTION`, `TESTING`. Files should only contain records from a single environment.
`authorisation_id`	string	Mandatory	Unique identifier of the authorisation request. Any format defined by the PSP. IDs longer than 64 characters will be truncated. Example: `b0a93f05-2e8d-4c3c-b409-6322d26b270e`.
`authorisation_type`	enum	Mandatory	Type of the authorisation. Allowed: `AUTHORISATION`, `REFUND`.
`authorisation_status`	enum	Mandatory	Status of the authorisation — approved or declined by the payment network, or cancelled by a third party (e.g. fraud detection) or internal PSP rules before it reached the network. Allowed: `APPROVED`, `DECLINED`, `CANCELLED`.
`authorisation_status_reason`	string	Mandatory	Reason the authorisation was declined or cancelled. Payment network reason code, internal PSP reason code, or any other explanation, preferably in English. Required when `authorisation_status` is `DECLINED` or `CANCELLED`; may be omitted for `APPROVED`. Example: `Invalid CVV`.
`authorisation_date_time`	datetime	Mandatory	Time at which the authorisation was requested from the payment network — ISO 8601. Ideally UTC with a `Z` designator or UTC offset. Example: `2024-06-19T09:34:45Z`.
`merchant_registration_id`	string	Mandatory	Legal registration ID of the merchant. If no matching merchant exists at processing time, a new merchant is created in an `INACTIVE` state until a matching record arrives via the merchants file. See Merchant Registration ID Types.
`merchant_registration_id_type`	string	Mandatory	Type of registration ID — see Merchant Registration ID Types. Example: `UEN`.
`merchant_registered_country`	country	Mandatory	Country where the merchant is legally registered — ISO 3166 alpha-2. Example: `SG`.
`internal_merchant_id`	string	Optional	Internal merchant ID of the account to which this authorisation belongs. IDs longer than 64 characters will be truncated. Example: `398-347-598`.
`mcc`	string	Mandatory	Merchant Category Code used during the authorisation — 4-digit string, ISO 18245. Example: `5251`.
`website_url`	url	Mandatory	Website URL from which the authorisation originated. Required when `channel` is `ONLINE`; may be blank otherwise. Example: `www.timstiles.com`.
`scheme_mid`	string	Optional	Scheme MID used in the original transaction, if known. Example: `1286459`.
`billing_descriptor`	string	Mandatory	Billing descriptor used during the authorisation. Required when `payment_method` is `CARD`; may be omitted otherwise. Example: `TIMS TILES`.
`card_bin`	string	Mandatory	First 6 or 8 digits of the card number used in the authorisation. Must be exactly 6 or 8 digits. Example: `413756`.
`authorisation_currency`	currency	Mandatory	Currency of the authorisation — ISO 4217 alpha-3. May differ from the merchant trading currency (e.g. for Multi-Currency Pricing). Example: `USD`.
`authorisation_amount`	decimal	Mandatory	Authorisation amount in the main unit of the currency, no thousand delimiters, dot as decimal separator. Amounts are rounded per Unicode CLDR. Negative values are converted via absolute value. Example: `20.00`.
`channel`	string	Mandatory	Channel through which the authorisation was requested. Allowed: `POS`, `ONLINE`, `OTHER`. Any other values are relabeled as `OTHER`.
`ip_address`	string	Mandatory	IPv4 or IPv6 address from which the transaction was initiated. Required when `channel` is `ONLINE`. Example: `83.48.126.235`.
`terminal_id`	string	Mandatory	Unique identifier of the terminal that processed the transaction. Required when `channel` is `POS`. Example: `10350001`.

Invalid values for any mandatory column will cause the record to be rejected and it must be re-sent in a subsequent file.

Envisso Integration Hub

Download CSV template

Download CSV template

Overview

Data Columns

Download CSV template

Download CSV template

​Overview

​Data Columns

Overview

Data Columns