Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
PAYMENTS

Get all authorizations

An authorization is a permission by a card issuer that a merchant can charge the customer in the future up to the specified amount. An authorization is created when a merchant uses the Bar Tabs and Authorizations apps.

get/v3/merchants/{mId}/authorizations

Path parameters

mIdstring required

Merchant ID

Query parameters

filterstring

Filter fields: [last4, note, amount, tabName, orderId, cardType, orderModifiedTime, type, device.id, token, result, authcode, externalReferenceId, paymentAttributePaymentId, closingPaymentId, merchantId, paymentId, createdTime, id, deletedTime]

expandstring

Expandable fields: [payment]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

idstring

13-digits unique ID of the Merchant.

tabNamestring

Name of tab

amountinteger

Amount authorized

cardType'VISA' | 'MC' | 'AMEX' | 'DISCOVER' | 'DINERS_CLUB' | 'JCB' | 'MAESTRO' | 'SOLO' | 'LASER' | 'CHINA_UNION_PAY' | 'CARTE_BLANCHE' | 'UNKNOWN' | 'GIFT_CARD' | 'EBT' | 'GIROCARD' | 'INTERAC' | 'OTHER' | 'RUPAY'

Type of credit card used for authorization.

last4string

Last 4 digits of credit card used for authorization

authcodestring

Authorization code

tokenstring

Token used for the authorization

type'TAB' | 'AUTH'
notestring
externalReferenceIdstring

External reference identifier, if associated with the payment.

createdTimeinteger

Time authorization was recorded on server.

transactionSequenceCounterstring

Counter maintained by the terminal that is incremented for each transaction.

acquirerTerminalIdstring

Acquirer Terminal ID of the terminal. For incremental authorization to refer to the terminal which does the increment.