(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Stripe Payment Gateway (Tokenisation)
This page details the inputs, secure inputs and outputs available for the Stripe Payment Gateway, how to complete each field, and an external link to the Stripe integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Inputs
Description
cust_name
No
n/a
Cardholder's full name.
cust_address_line1
No
n/a
Address line 1 (Street address / PO Box / Company name).
cust_address_line2
No
n/a
Address line 2 (Apartment / Suite / Unit / Building).
cust_address_city
No
n/a
City / District / Suburb / Town / Village.
cust_address_state
No
n/a
State / County / Province / Region.
cust_address_zip
No
n/a
ZIP or postal code.
cust_address_country
No
n/a
Billing address country, if provided.
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
number
Yes
19 num
Secure input of the card number
fullexpiry
Yes
2 num
Secure input of the card expiry - in the format MM
cvc
Yes
3 or 4 num
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
id
ID of the token
object
The type of object (token)
card_id
ID of the card
card_object
The type of object (card)
card_address_country
Country for the cardholder
card_address_line1
Address line 1 (Street address/PO Box/Company name).
card_address_line1_check
If a address line1 was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.
card_address_line2
Address line 2 (Apartment/Suite/Unit/Building).
card_address_city
City/District/Suburb/Town/Village.
card_address_state
State/County/Province/Region.
card_address_zip
ZIP or postal code.
card_addresss_zip_check
If a address postal code was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.
card_brand
Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown.
card_country
Two-letter ISO code representing the country of the card.
card_cvc_check
If a CVC was provided, results of the check, one of ‘pass’, ‘failed’, ‘unavailable’ or ‘unchecked’.
card_dynamic_last4
(For tokenized numbers only.) The last four digits of the device account number.
card_exp_month
Two-digit number representing the card’s expiration month.
card_exp_year
Four-digit number representing the card’s expiration year.
card_fingerprint
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example.
card_funding
Card funding type. Can be credit, debit, prepaid, or unknown.
card_last4
The last four digits of the card.
card_metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
card_name
Cardholder name.
card_tokenization_method
If the card number is tokenized, this is the method that was used. Can be apple_pay or google_pay.
created
Time at which the object was created. Measured in seconds since the Unix epoch.
livemode
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
resp_type
Type of the token: account, bank_account, card, or pii.
used
Whether this token has already been used (tokens can be used only once).
error_code
For some errors that could be handled programmatically, a short string indicating the error code reported.
error_doc_url
A URL to more information about the error code reported.
error_message
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
error_type
The type of error returned. One of api_connection_error, api_error, authentication_error, card_error, idempotency_error, invalid_request_error, or rate_limit_error
error_param
If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
Further information can be found by viewing the integration documentation:
