(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Chargebee Payment Gateway
This page details the inputs, secure inputs and outputs available for the Chargebee Payment Gateway, how to complete each field, and an external link to the Chargebee 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 Input
Description
customerId
Yes
50 char
Identifier of the customer with whom this payment source is associated.
replacePrimaryPaymentSource
Yes
boolean
Indicates whether the primary payment source should be replaced with this payment source.
Secure Inputs
Inputs Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 char
Secure input of the card number
cardExpiry
Yes
4 char
Secure input of the card expiry - in the format MMYY
cardCVV
Yes
3 or 4 char
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
paymentSourceId
Identifier of the payment source.
paymentSourceUpdatedAt
Timestamp indicating when this payment source resource was last updated.
customerIdOut
Identifier of the customer with whom this payment source is associated.
paymentSourceReferenceId
The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Note: This is not the one time temporary token provided by gateways like Stripe.
paymentSourceStatus
Current status of the payment source. Possible values are –
valid
A payment source that is valid and active.
expiring
A payment source that is expiring (like card's status based on its expiry date).
expired
A payment source that has expired.
invalid
The billing agreement cannot be used. It might become valid again either automatically or due to customer action.
pending_verification
The payment source needs to be verified.
paymentSourceGatewayAccountId
The gateway account to which this payment source is stored with.
cardIin
The Issuer Identification Number, i.e. the first six digits of the card number.
cardLast4
Last four digits of the card number.
cardExpiryMonthOut
Card expiry month.
cardExpiryYearOut
Card expiry year
cardMaskedNumber
Masked credit card number that is safe to show.
cardBrand
Card brand. Eg. visa, mastercard
customerFirstName
First name of the customer.
customerLastName
Last name of the customer.
customerEmail
Email of the customer. Configured email notifications will be sent to this email.
customerPhone
Phone number of the customer.
customerCompany
Company name of the customer.
customerPrimaryPaymentSourceId
Primary payment source for the customer.
paymentMethodReferenceId
The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource.
Note: This is not the one time temporary token provided by gateways like Stripe.
paymentMethodStatus
Current status of the payment source.
Further information can be found by viewing the integration documentation:
