Skip to main content

Authorization

Contains information for wallet authorization.

idstringrequired

Authorization id

Possible values: <= 50 characters

Example: 1fdc330b-5fa4-4cb9-b9d8-c74f65ac32f1
customerIdstringrequired

Wallet customer id.

Example: 5435323362
accountIdstringrequired

Account Id associated with this authorization.

Example: 1100000001330524
cardIdstring

Card id.

Example: 44991630-8546-41cf-a5bd-669b8d4687da
cardPresencestring

Card presence.

  • PRESENT - The cardholder presents their physical credit or debit card to the business at the point of sale.
  • NOT_PRESENT - Card is not present at the point of sale. Card-not-present transactions are typical for e-commerce purchases.
  • UNKNOWN - The merchant acquirer does not provide information about the card presence.

Possible values: <= 50 characters, [PRESENT, NOT_PRESENT, UNKNOWN]

slipIdstring

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

Example: 5009964049
challengestring

Challenge.

  • PIN - The cardholder verification method used during 3Ds authentication.
  • THREE_DS - (Deprecated! Use 3DS!) The cardholder verification method used during 3Ds authentication.
  • 3DS - The cardholder verification method used during 3Ds authentication.
  • ONLINE - The cardholder verification method used during 3Ds authentication.
  • BIOMETRIC - The cardholder verification method used during 3Ds authentication.
  • BIOGRAPHIC - The cardholder verification method used during 3Ds authentication.
  • MANUAL_SIGNATURE - The cardholder verification method used during 3Ds authentication.
  • ELECTRONIC_SIGNATURE - The cardholder verification method used during 3Ds authentication.
  • MANUAL_OTHER - The cardholder verification method used during 3Ds authentication.
  • UNKNOWN - The cardholder verification method used during 3Ds authentication.

Possible values: <= 50 characters, [PIN, THREE_DS, 3DS, ONLINE, BIOMETRIC, BIOGRAPHIC, MANUAL_SIGNATURE, ELECTRONIC_SIGNATURE, MANUAL_OTHER, UNKNOWN]

cardholderPresencestring

Cardholder presence.

  • PRESENT - Cardholder is present at the point of sale.
  • NOT_PRESENT_UNSPECIFIED - Cardholder is not present. Merchant acquirer does not provide additional details.
  • NOT_PRESENT_MAIL_ORDER - Cardholder is not present. The order was taken over the mail.
  • NOT_PRESENT_PHONE_ORDER - Cardholder is not present. The order was taken over the phone.
  • NOT_PRESENT_RECURRING - Cardholder is not present. Recurring payment.
  • NOT_PRESENT_ECOMMERCE - Cardholder is not present. E-commerce payment.
  • NOT_PRESENT_INSTALLMENT - Cardholder is not present. Payment with installments. Not supported in UK and EEA.
  • UNKNOWN - Merchant acquired/Processing partner does not provide information about cardholder presence.

Possible values: <= 50 characters, [PRESENT, NOT_PRESENT_UNSPECIFIED, NOT_PRESENT_MAIL_ORDER, NOT_PRESENT_PHONE_ORDER, NOT_PRESENT_RECURRING, NOT_PRESENT_ECOMMERCE, NOT_PRESENT_INSTALLMENT, UNKNOWN]

netAmountint64

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

Example: 1000
netCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
customerAmountint64

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

Example: 1000
customerCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
transactionAmountint64

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

Example: 1000
transactionCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
cardAmountint64

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.

Example: 1000
cardCurrencyCurrency (string)

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
fees object[]

Customer fees attached to the authorization, in minor units.

  • Array [
    • amountint64required

    Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

    Default value: 0
    Example: 1000
    currencyCurrency (string)

    Currency alphabetic code as specified by ISO 4217

    Possible values: >= 3 characters and <= 3 characters

    Example: EUR
    paymentReasonFeePaymentReason (string)required

    Fee payment reason.

    • SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
    • RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
    • DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
    • WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
    • MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
    • PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
    • ATM_FEE - Fee for ATM service, when using prepaid cards.
    • FX_FEE - Fee applied, when payment requires currency exchange.
    • OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction

    Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

    Default value: OTHER_FEE
  • ]
    • creationTimedate-time

    Represents RFC 3339, section 5.6 date-time.

    Example: 2021-07-15T17:54:12Z
    directionstringrequired

    Authorization direction.

    Possible values: [CREDIT, DEBIT]

    typestring

    Authorization trn type.

    • BALANCE_INQUIRY - Balance check on an ATM.
    • CARD_DATA_FILE_ACTION - Card data file action.
    • CREDIT_ADJUSTMENT
    • CREDIT_DEPOSIT
    • CREDIT_ORIGINAL
    • CREDIT_PAYMENT_TRANSACTION
    • CREDIT_REFUND - A refund of a previous purchase is received.
    • DEBIT_ADJUSTMENT
    • DEBIT_ATM_WITHDRAWAL - ATM withdrawal attempt.
    • DEBIT_CASH_ADVANCE - Cash advance attempt. Cardholder attempted to over-the-counter cash withdrawal and a financial institution. Presently not supported.
    • DEBIT_GOODS_AND_SERVICES - Regular purchase of goods and services.
    • DEBIT_GOODS_WITH_CASHBACK - A purchase with cashback was attempted. Cardholder makes a purchase and also asks to receive a small amount in case at the cashier. Currently not supported.
    • PIN_CHANGE - PIN chance at an ATM.
    • PIN_UNBLOCK - PIN unblock at an ATM.
    • QUASI_CASH -Applicable to Visa only. Currently disabled. Quasi Cash is when you use your card to purchase money orders, travellers checks, foreign currency, lottery tickets, casino chips, vouchers which are redeemable for cash, or racetrack.
    • TOKENIZATION_ACTIVATION_CODE - An OTP code received when cardholder attempt to add their card to a mobile wallet (e.g. Google Pay, Apple Pay).
    • TOKENIZATION_AUTHORIZATION - A request to add a card to a Mobile wallet.
    • TOKENIZATION_COMPLETE - Card is successfully added to a mobile wallet (e.g. Google Pay, Apple Pay).
    • TOKENIZATION_EVENT_NOTIFICATION - Change notification (activation, status change or deletion) for a card token linked to a mobile wallet.
    • UNIQUE_TRANSACTION - Unique Transaction (requires unique MCC). Mastercard-specific transaction category. Similar to Visa's quasi-cash, this is used for specific merchants where the purchased items could be converted to cash (e.g., gaming chips, money orders).

    Possible values: [BALANCE_INQUIRY, CARD_DATA_FILE_ACTION, CREDIT_ADJUSTMENT, CREDIT_DEPOSIT, CREDIT_ORIGINAL, CREDIT_PAYMENT_TRANSACTION, CREDIT_REFUND, DEBIT_ADJUSTMENT, DEBIT_ATM_WITHDRAWAL, DEBIT_CASH_ADVANCE, DEBIT_GOODS_AND_SERVICES, DEBIT_GOODS_WITH_CASHBACK, PIN_CHANGE, PIN_UNBLOCK, QUASI_CASH, TOKENIZATION_ACTIVATION_CODE, TOKENIZATION_AUTHORIZATION, TOKENIZATION_COMPLETE, TOKENIZATION_EVENT_NOTIFICATION, UNIQUE_TRANSACTION]

    statusstringrequired

    Prepaid Card Authorization status.

    • APPROVED - A payment authorization is approved.
    • DECLINED - A declined card payment.
    • EXPIRED - A previously approved card authorization expired as clearing was not received within the required time-frame.
    • FAILED - Authorization failed due to a technical timeout. Please try again later.
    • SETTLED - A card payment that a clearing was received for. As a result the status changed to SETTLED.
    • SETTLED_PARTIAL - Merchants usually clear an authorization with a single clearing message. On rare occasions the merchant obtains pre-authorization for a group of items that are later shipped separately, and the merchant sends a separate clearing message for each portion of the order as it ships.This status is used for such partial clearing messages. The remainder of the pre-authorized amount remains on hold until all clearing messages are received. Or until the pre-authorization expires.
    • SETTLED_RELEASE_FAIL - An error message used when an authorization was expired, but the reserved amount was not released. Please contact your relationship manager in such cases.
    • FORCED_BAL_RELEASE - Used in cases where an authorization was manually released before its expiry date by a member of staff.

    Possible values: <= 100 characters, [APPROVED, DECLINED, EXPIRED, FAILED, REVERSED, SETTLED, SETTLED_PARTIAL, SETTLED_RELEASE_FAIL, FORCED_BAL_RELEASE, UNKNOWN]

    panEntryMethodstring

    Pan entry method.

    • MANUAL - Card is manually keyed at the point of sale.
    • OCR - Card details obtained via OCR.
    • BARCODE - Card details obtained via optical code.
    • UNKNOWN - Merchant acquirer does not specify the PAN entry method.
    • E_COMMERCE - Card details obtained online.
    • EMV_CONTACT - Card details obtained via card chip at a POS.
    • PAN_ON_FILE - Credentials on file purchase.
    • MAGNETIC_STRIPE -Card details obtained via magnetic stripe. Currently disabled.
    • MAGNETIC_STRIPE_PARTIAL - Card details obtained via magnetic stripe. Currently disabled.
    • EMV_CONTACTLESS - Contactless purchase at the point of sale.
    • CREDENTIALS_ON_FILE - Card details obtained via stored credentials.
    • MAGNETIC_STRIPE_FALLBACK - Fallback to magnetic stripe at a chip-enabled POS. Not supported.
    • MAGNETIC_STRIPE_CONTACTLESS - Currently not supported. Merchant tried perform contactless transaction by obtaining the card details from the magnetic stripe.
    • PAN_EXP_DATE_BY_ACQUIRER - Not applicable.
    • PRE_REGISTERED_CHECKOUT_SERVICE

    Possible values: <= 100 characters, [MANUAL, OCR, BARCODE, UNKNOWN, E_COMMERCE, EMV_CONTACT, PAN_ON_FILE, MAGNETIC_STRIPE, MAGNETIC_STRIPE_PARTIAL, EMV_CONTACTLESS, CREDENTIALS_ON_FILE, MAGNETIC_STRIPE_FALLBACK, MAGNETIC_STRIPE_CONTACTLESS, PAN_EXP_DATE_BY_ACQUIRER, PRE_REGISTERED_CHECKOUT_SERVICE]

    merchantNamestring

    Merchant name.

    Possible values: <= 100 characters

    merchantCitystring

    Merchant city.

    Possible values: <= 50 characters

    merchantCountryCountryCode (string)

    ISO-3166 Alpha 2

    Possible values: >= 2 characters and <= 2 characters

    Example: GB
    merchantStatestring

    Merchant state.

    Possible values: <= 20 characters

    mccinteger

    Merchant category code.

    mobileWalletstring

    Mobile wallet.

    Possible values: <= 50 characters

    responseCodestring

    Response code.

    Possible values: <= 50 characters

    Authorization
    {
      "id": "1fdc330b-5fa4-4cb9-b9d8-c74f65ac32f1",
      "customerId": "5435323362",
      "accountId": "1100000001330524",
      "cardId": "44991630-8546-41cf-a5bd-669b8d4687da",
      "cardPresence": "PRESENT",
      "slipId": "5009964049",
      "challenge": "PIN",
      "cardholderPresence": "PRESENT",
      "netAmount": 1000,
      "netCurrency": "EUR",
      "customerAmount": 1000,
      "customerCurrency": "EUR",
      "transactionAmount": 1000,
      "transactionCurrency": "EUR",
      "cardAmount": 1000,
      "cardCurrency": "EUR",
      "fees": [
        {
          "amount": 1000,
          "currency": "EUR",
          "paymentReason": "OTHER_FEE"
        }
      ],
      "creationTime": "2021-07-15T17:54:12Z",
      "direction": "CREDIT",
      "type": "BALANCE_INQUIRY",
      "status": "APPROVED",
      "panEntryMethod": "MANUAL",
      "merchantName": "string",
      "merchantCity": "string",
      "merchantCountry": "GB",
      "merchantState": "string",
      "mcc": 0,
      "mobileWallet": "string",
      "responseCode": "string"
    }