Cmdlets for Stripe

Build 24.0.9060

Authorizations

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Table Specific Information

Select

Server-Side Query Support

The cmdlet uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the cmdlet.

  • Id supports the following operator: =.
  • CardId supports the following operator: =.
  • CardCardholderId supports the following operator: =.
  • Status supports the following operator: =.
  • Created supports the following operator: =.

You can select from Authorizations with the following queries: 

    SELECT * from Authorizations WHERE CardId = 'ic_1Nsse72eZvKYlo2CWBGm2WQ5'
    SELECT * from Authorizations WHERE CardCardholderId = 'ich_1NpvWO2eZvKYlo2CAQ7YPOvp'
    SELECT * from Authorizations WHERE Id = 'iauth_1ObVV22eZvKYlo2C9UYAEpOT'

Columns

Name Type References Description
Id [KEY] String Unique identifier for the object.
Amount Integer The total amount that was authorized or rejected.
AmountDetailsAtmFee Integer The fee charged by the ATM for the cash withdrawal.
AmountDetailsCashbackAmount Integer The amount of cash requested by the cardholder.
Approved Boolean Whether the authorization has been approved.
AuthorizationMethod String How the card details were provided.
BalanceTransactions String List of balance transactions associated with this authorization.
CardId String Unique identifier for the object.
CardObject String String representing the objects type. Objects of the same type share the same value.
CardBrand String The brand of the card.
CardCancellation_reason String The reason why the card was canceled.
CardCardholderId String Unique identifier for the object.
CardCardholderObject String String representing the objects type. Objects of the same type share the same value.
CardCardholderBillingAddressCity String City, district, suburb, town, or village.
CardCardholderBillingAddressCountry String Two-letter country code
CardCardholderBillingAddressLine1 String Address line 1
CardCardholderBillingAddressLine2 String Address line 2
CardCardholderBillingAddressPostalCode String ZIP or postal code.
CardCardholderBillingAddressState String State, county, province, or region.
CardCardholderCompanyTaxIdProvided Boolean Whether the companys business ID number was provided.
CardCardholderCreated Datetime Time at which the object was created. Measured in seconds since the Unix epoch.
CardCardholderEmail String The cardholders email address.
CardIssuingUserTermsAcceptanceDate Datetime The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
CardIssuingUserTermsAcceptanceIP String The IP address from which the cardholder accepted the Authorized User Terms.
CardIssuingUserTermsAcceptanceUserAgent String The user agent of the browser from which the cardholder accepted the Authorized User Terms.
CardCardholderDOBDay Integer The day of birth, between 1 and 31.
CardCardholderDOBMonth Integer The month of birth, between 1 and 12.
CardCardholderDOBYear Integer The four-digit year of birth.
CardCardholderFirstName String The first name of this cardholder.
CardCardholderLastName String The last name of this cardholder.
CardCardholderVerficationDocBack String The back of a document returned by a file upload with a purpose value of identity_document.
CardCardholderVerficationDocFront String The front of a document returned by a file upload with a purpose value of identity_document.
CardCardholderLivemode Boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
CardCardholderMetadataAggregate String The set of key/value pairs that you can attach to a an object.
CardCardholderName String The cardholders name. This will be printed on cards issued to them.
CardCardholderPhoneNumber String The cardholders phone number. This is required for all cardholders who will be creating EU cards.
CardCardholderPreferredLocales String The cardholders preferred locales (languages), ordered by preference.
CardCardholderRequirementsDisabledReason String If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
CardCardholderRequirementsPastDue String Array of fields that need to be collected in order to verify and re-enable the cardholder.
CardCardholderSpendingControlsAllowedCategories String Array of strings containing categories of authorizations to allow.
CardCardholderSpendingControlsBlockedCategories String Array of strings containing categories of authorizations to decline.
CardCardholderSpendingControlsSpendingLimits String Limit spending with amount-based rules that apply across this cardholders cards.
CardCardholderSpendingControlsSpendingLimitsCurrency String Currency of the amounts within spending_limits.
CardCardholderStatus String Specifies whether to permit authorizations on this cardholder’s cards.
CardCardholderType String One of individual or company.
CardCreated Datetime Time at which the object was created. Measured in seconds since the Unix epoch.
CardCurrency String Three-letter ISO currency code, in lowercase.
CardCVC String The cards CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter.
CardExpMonth Integer The expiration month of the card.
CardExpYear Integer The expiration year of the card.
CardLast4 String The last 4 digits of the card number.
CardLivemode Boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
CardMetadataAggregate String The set of key/value pairs that you can attach to a an object.
CardNumber String The full unredacted card number.
CardReplacedBy String The latest card that replaces this card, if any.
CardReplacementFor String The card this card replaces, if any.
CardReplacementReason String The reason why the previous card needed to be replaced.
CardShipping String Where and how the card will be shipped.
CardCardholderSpendingControlsAllowedMerchantCountries String Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
CardCardholderSpendingControlsBlockedMerchantCountries String Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
CardPersonalizationDesign String The personalization design object belonging to this card.
CardSpendingControlsAllowedCategories String Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with blocked_categories.
CardSpendingControlsAllowedMerchantCountries String Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with blocked_merchant_countries. Provide an empty value to unset this control.
CardSpendingControlsBlockedCategories String Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with allowed_categories.
CardSpendingControlsBlockedMerchantCountries String Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. US). Cannot be set with allowed_merchant_countries. Provide an empty value to unset this control.
CardSpendingControlsSpendingLimits String Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its replacement_for card and that card’s replacement_for card, up the chain).
CardSpendingControlsSpendingLimitsCurrency String Currency of the amounts within spending_limits. Always the same as the currency of the card.
CardType String The type of the card. Possible enum values: physical, virtual.
CardWalletsApplePayEligible Boolean Apple Pay Eligibility.
CardWalletsApplePayIneligibleReason String Reason the card is ineligible for Apple Pay.
CardWalletsGooglePayEligible Boolean Google Pay Eligibility.
CardWalletsGooglePayIneligibleReason String Reason the card is ineligible for Google Pay.
CardWalletsPrimaryAccountIdentifier String Unique identifier for a card used with digital wallets.
Cardholder String The cardholder to whom this authorization belongs.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060