×
Menu

PaymentOS Payment Gateway

 
This page details the inputs, secure inputs and outputs available for the PaymentOS Payment Gateway, how to complete each field, and an external link to the PaymentOS 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
app_id
Y
N/A
Unique application ID for the payment cartridge by PaymentOS
public_key
Y
N/A
Unique public key for the paymenr cartridge by PaymentOS
private_key
Y
N/A
Unique private key for the payment cartridge by PaymentOS
xpaymentsosenv
Y
test/live
Mode to be used - test/live
holder_name
Y
N/A
Card holder name
amount
Y
N/A
Amount in base units
currency
Y
3 char
3 digit ISO currency code e.g. GBP, USD, EUR
order_id
Y
N/A
Unique order ID for the transaction
customer_reference
N
N/A
Unique customer reference for the transaction
customer_first_name
N
N/A
Customer first name
customer_last_name
N
N/A
Customer last name
customer_email
N
N/A
Customer email address
customer_id
N
N/A
Customer ID - Must be created in order to be used.
shipping_address_country
N
3 char
Shipping Address Country Code e.g. GBR
shipping_address_state
N
N/A
Shipping Address State Code/Name
shipping_address_city
N
N/A
Shipping Address City
shipping_address_line1
N
N/A
Shipping Address Line 1
shipping_address_line2
N
N/A
Shipping Address Line 2
shipping_address_zip_code
N
N/A
Shipping ZIP/Postal Code
shipping_address_title
N
N/A
Shipping Address Title
shipping_address_first_name
N
N/A
Shipping Address First Name
shipping_address_last_name
N
N/A
Shipping Address Last Name
shipping_address_phone
N
N/A
Shipping Address Phone Number
shipping_address_email
N
N/A
Shipping Address Email Address
billing_address_country
N
3 char
Shipping Address Country Code e.g. GBR
billing_address_state
N
N/A
Billing Address State Code/Name
billing_address_city
N
N/A
Billing Address City
billing_address_line1
N
N/A
Billing Address Line 1
billing_address_line2
N
N/A
Billing Address Line 2
billing_address_zip_code
N
N/A
Billing Address ZIP/Postal Code
billing_address_title
N
N/A
Billing Address Title
billing_address_first_name
N
N/A
Billing Address First Name
billing_address_last_name
N
N/A
Billing Address Last Name
billing_address_phone
N
N/A
Billing Address Phone Number
billing_address_email
N
N/A
Billing Address Email Address
token
Y
N/A
Card Token to be used for Authorisation
 
 
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
cardNumber
Yes
19 num
Secure input of the card number
expiry
Yes
2 num
Secure input of the card expiry - in the format MMYY
cvv
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
type
Depending on the token_type, this field represents either the card's or billing agreement's representation as it will be used in an authorization or charge request.
level
The level of benefits or services available with the card.
state
Reflects the token's usage. The state can be one of the following:
    valid: token has been successfully created and can be used. Only applies to tokens created in API version 1.1.0 or below.
The following states apply to version 1.2.0 or higher:
    created: token has been successfully created but has not yet been used or assigned to a customer.
    used: token has been used in a successful authorize or charge request.
    assigned: the token is assigned to a customer. The token will remain in this state also if it is used in a new authorize or charge request.
token
Depending on the token_type, the token represents one of the following: a customer's credit card number, the card cvv code or a billing agreement.
issuer
The name of the bank that issued the card.
vendor
The name of the credit card corporation.
created
The date and time that the token was created.
card_type
The type of card.
bin_number
The initial four to six numbers that appear on the card.
country_code
The 3-digit country code defined in ISO 3166-1 alpha-3 format, identifying the country in which the card was issued.
encrypted_cvv
This value can be used in a 'create authorization' or 'create charge' request, as the 'credit_card_cvv' field. The 'encrypted_cvv' field expires after three hours.
last_4_digits
Masked credit card number (last four digits).
pass_luhn_validation
When token_type is credit_card, then this indicates if the credit card number passed the luhn validation. Read more about the Luhn Algorithm.
id
Identifier of the payment.
status
The status of the payment. "Initialized" "Credited" "Pending" "Authorized" "Captured" "Refunded" "Voided"
is_chargedback
Is the transaction a chargeback.
payment_method_type
The type of payment method. Possible value: tokenized.
payment_method_token
Depending on the token_type, the token represents one of the following: a customer's credit card number, the card cvv code or a billing agreement.
payment_method_holder_name
Name of the credit card holder.
payment_method_expiration_date
"Credit card expiration date." "Possible formats: mm-yyyy, mm-yy, mm.yyyy, mm.yy, mm/yy, mm/yyyy, mm yyyy, or mm yy."
payment_method_last_4_digits
Masked credit card number (last four digits).
payment_method_fingerprint
Uniquely identifies this particular card number. You can use this attribute to check whether two tokens represent the same card number.
payment_method_bin_number
The initial four to six numbers that appear on the card.
payment_method_vendor
The name of the credit card corporation.
payment_method_issuer
The name of the bank that issued the card.
payment_method_card_type
The type of card.
payment_method_country_code
The 3-digit country code defined in ISO 3166-1 alpha-3 format, identifying the country in which the card was issued.
result_status
Result of the operation or transaction.
provider_data_provider_name
Name of the external provider.
provider_data_avs_code
Result of the AVS address check received. For more details see the Address Verification System
provider_data_raw_response
The raw response received. This field is for support and debugging purposes only.
provider_data_transaction_id
The ID of the transaction in the provider's system.
provider_data_external_id
The ID of the payment in the provider's system.
provider_configuration_id
The provider configuration id.
provider_configuration_name
The provider configuration name.
provider_configuration_description
The provider configuration description.
provider_configuration_account_id
The identifier of the merchant account.
provider_configuration_provider_id
The identifier of the provider.
provider_configuration_type
The provider type of the provider configuration.
errorMessage
PCI Pal configured error message.
 
The help manual was created with Dr.Explain