Interface Authorization

Contains information for wallet authorization.

interface Authorization {
    accountId: string;
    cardAmount?: number;
    cardCurrency?: string;
    cardId?: string;
    cardPresence?: CardPresence;
    cardholderPresence?: CardholderPresence;
    challenge?: Challenge;
    creationTime?: string;
    customerAmount?: number;
    customerCurrency?: string;
    customerId: string;
    direction: AuthorizationDirection;
    fees?: SimpleFeePayment[];
    id: string;
    mcc?: number;
    merchantCity?: string;
    merchantCountry?: string;
    merchantName?: string;
    merchantState?: string;
    mobileWallet?: string;
    netAmount?: number;
    netCurrency?: string;
    panEntryMethod?: PanEntryMethod;
    responseCode?: string;
    slipId?: string;
    status: AuthorizationStatus;
    transactionAmount?: number;
    transactionCurrency?: string;
    type?: AuthorizationType;
}

Properties

accountId cardAmount? cardCurrency? cardId? cardPresence? cardholderPresence? challenge? creationTime? customerAmount? customerCurrency? customerId direction fees? id mcc? merchantCity? merchantCountry? merchantName? merchantState? mobileWallet? netAmount? netCurrency? panEntryMethod? responseCode? slipId? status transactionAmount? transactionCurrency? type?

Properties

accountId

accountId: string

Account Id associated with this authorization.

Optional cardAmount

cardAmount?: number

The amount in the currency of the card, in minor units. Card currency and wallet currency are always USD in the USA. For the other markets, please reach out to your implementation manager.

Optional cardCurrency

cardCurrency?: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional cardId

cardId?: string

Card id.

Optional cardPresence

cardPresence?: CardPresence

Card presence.

Optional cardholderPresence

cardholderPresence?: CardholderPresence

Cardholder presence.

Optional challenge

challenge?: Challenge

Challenge.

Optional creationTime

creationTime?: string

Creation time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

"2021-07-15T17:54:12Z"

Optional customerAmount

customerAmount?: number

The transaction amount in wallet currency including all transactional fees, in minor units.

Optional customerCurrency

customerCurrency?: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

customerId

customerId: string

Wallet customer id.

direction

direction: AuthorizationDirection

Authorization direction.

Optional fees

fees?: SimpleFeePayment[]

Customer fees attached to the authorization, in minor units.

id

id: string

Authorization id.

Optional mcc

mcc?: number

Merchant category code.

Optional merchantCity

merchantCity?: string

Merchant city.

Optional merchantCountry

merchantCountry?: string

Merchant country. Represents ISO-3166 Alpha 2 country code.

Example

"GB"

Optional merchantName

merchantName?: string

Merchant name.

Optional merchantState

merchantState?: string

Merchant state.

Optional mobileWallet

mobileWallet?: string

Mobile wallet.

Optional netAmount

netAmount?: number

The net amount of the transaction in wallet currency, in minor units. Does not include any fees.

Optional netCurrency

netCurrency?: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional panEntryMethod

panEntryMethod?: PanEntryMethod

Pan entry method.

Optional responseCode

responseCode?: string

Response code.

Optional slipId

slipId?: string

ID of the settlement slip. Available only if the authorization is settled and a settlement transaction is created. The value can be used in a request to the transaction history endpoint to retrieve the settlement transaction.

status

status: AuthorizationStatus

Prepaid Card Authorization status.

Optional transactionAmount

transactionAmount?: number

The transaction amount at the point of sale, in minor units. Does not include any fees.

Optional transactionCurrency

transactionCurrency?: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional type

type?: AuthorizationType

Authorization transaction type.

Settings

Member Visibility

Theme

On This Page

accountIdcardAmountcardCurrencycardIdcardPresencecardholderPresencechallengecreationTimecustomerAmountcustomerCurrencycustomerIddirectionfeesidmccmerchantCitymerchantCountrymerchantNamemerchantStatemobileWalletnetAmountnetCurrencypanEntryMethodresponseCodeslipIdstatustransactionAmounttransactionCurrencytype