×
Menu
Search
 
   
   
   
 
  (c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)

PayOn Payment Gateway

 
This page details the inputs, secure inputs and outputs available for the PayOn Logic Item, how to complete each field, and an external link to the PayOn 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
authenticationUserId
Yes
Unique per client
Unique user id for the client
authenticationPassword
Yes
Unique per client
Unique password for the client
authenticationEntityId
Yes
Unique per client
Unique entity ID for the client
amount
Yes
0.01 - 100,000.00
Two decimal places are allowed, for example '3.25' is allowed, '3.256' will be rejected
currency
Yes
3 chars
Standard currency  codes are permitted, for example GBP or EUR
paymentBrand
Yes
32 chars
Card type which is being taken, for example, VISA
paymentType
Yes
2 chars
The type of request which is being made, the following types accepted are:
PA - Preauthorization: A standalone authorisation - a following Capture with reference to the Preauthorisation will confirm this(not supported )
DB - Debit: Debits the account of the end customer and debits the merchant account
CD - Credits the account of the end customer and debits the merchant account
descriptor
No
127 chars
Description of what the payment is for, or what it is about
merchantTransactionId
No
255 chars
Merchant provided reference number,  unique for each individual transaction
merchantInvoiceId
No
255 chars
Merchant provided invoice number, unique for each individual transaction
card.holder
No
128 chars
Holder of the credit card account
billing.street1
No (C)
100 chars
Billing address line 1
billing.street2
No (C)
100 chars
Billing address line 2 (optional)
billing.city
No (C)
80 chars
Billing city
billing.state
No (C)
50 chars
Billing US state codes, for example AL, MS, NY
billing.postcode
No (C)
30 chars
Billing postcode which follows the format of postcodes. Can include a space
billing.country
No (C)
2 chars
Billing country, ISO format, for example, GB, IE, DE
createRegistration
Yes
5 chars
This is used if a token needs to be stored.  The following values are accepted:
  • true - a token will be created and stored along with the transaction
  • false - a token will not be created or stored along with the transaction
shipping.street1
No (C)
100 chars
Shipping address line 1
shipping.street2
No (C)
100 chars
Shipping address line 2 (optional)
shipping.city
No (C)
80 chars
Shipping city
shipping.state
No (C)
50 chars
Shipping US state codes, for example; AL, MS, NY
shipping.postcode
No (C)
30 chars
Shipping postcode which follows the format of postcodes.  Can include a space
shipping.country
No (C)
2 chars
Shipping country, ISO format, for example, GB, IE, DE
shipping.method
No (C)
30 chars
Method of shipping for this order, can be:
LOWEST_COST, CARRIER_DESIGNATED_BY_CUSTOMER, ELECTRONIC_DELIVERY, GROUND, INTERNATIONAL, MILITARY, NEXT_DAY_OVERNIGHT, OTHER, STORE_PICKUP, SAME_DAY_SERVICE, TWO_DAY_SERVICE, THREE_DAY_SERVICE
shipping.comment
No (C)
160 chars
A comment for the shipping
merchant.name
No (C)
100 chars
Merchant name (full name)
merchant.street
No (C)
100 chars
Merchant address: street
merchant.city
No (C)
80 chars
Merchant address: city
merchant.state
No (C)
50 chars
Merchant address: State, US States format, for example, AL, MS, NY
merchant.country
No (C)
2 chars
Merchant Country, ISO format, for example, GB, IE, DE
merchant.phone
No (C)
25 chars
Merchant phone number
merchant.mcc
No (C)
4 chars
Merchant category code
merchant.submerchantId
No (C)
100 chars
Used only for MasterCard Payment Facilitators, ID for the sub-merchant
virtualAccount.accountId
No (C)
100 chars
The identifier of the shopper's virtual account
virtualAccount.password
No (C)
100 chars
The password of the shopper's virtual account. Required for only some brands
customer.merchantCustomerId
No (C)
255 chars
An identifier for this customer. Typically this is the ID that identifies the shopper in the shop's system
customer.givenName
No (C)
48 chars
Customer first name
customer.middleName
No (C)
50 chars
Customer middle name
customer.surname
No (C)
48 chars
Customer surname
customer.sex
No (C)
1 char
Customer sex - either M or F
customer.birthDate
No (C)
10 chars
Customer date of birth, format: YYYY-MM-DD (for example, 1970-02-17)
customer.phone
No (C)
25 chars
Customer phone number, required for some risk checks
customer.mobile
No (C)
25 chars
Customer mobile number, required for some risk checks
customer.workPhone
No (C)
25 chars
Customer work phone number, required for some risk checks
customer.email
No (C)
128 chars
Customer email address, required for some risk checks, and transmission of some direct debit mandates
customer.identificationDocType
No (C)
12 chars
Customer ID documentation type, this can be any of the following:
IDCARD,
PASSPORT
TAXSTATEMENT
customer.identificationDocId
No (C)
64 chars
The ID of the document type which has been selected
customer.ip
No (C)
255 chars
Customers IP address.  This will often be stored in the clients backend CRM
customer.browserFingerprint.id
No (C)
N/A
A reference to the customers browser fingerprint, often in JavaScript
customer.browserFingerprint.value
No (C)
N/A
The value of the browser fingerprint
customer.status
No (C)
9 chars
A status of the customer.  Will either be:
NEW
EXISTING
testMode
Yes
8 chars
When working on a test transaction, it is important to set this value:
EXTERNAL - forces test transactions to be forwarded to the clients processors system for end-to-end testing
INTERNAL - forces test transactions to be forwarded to PayOn's processor system, which is useful for when testing connectivity between endpoints
 
Secure Inputs
Input Fields
Required
Character Limits/
Required Input
Description
card.number
Yes
19 chars
Secure input of the card number
card.expiry
Yes
4 chars
Secure input of the card expiry - in the format MMYY
card.cvv
Yes
3 or 4 chars
Secure input of the card CVV, either three or four digits long depending on the card
 
Outputs
Output Fields
Description
id
A unique transaction id which is generated by PayOn
registrationid
The token generated by PayOn should createRegistration be set to TRUE in the flow
referencedId
In case of referenced payment (e.g., Capture or Refund), this fields included to see which payment was referenced
paymentTye
Relative to the paymentType sent in the original transaction request
paymentBrand
Relative to the paymentBrand sent in the original transaction request
amount
The amount of the request
currency
The currency of the request
descriptor
If it has been populated, this is the descriptor used on the transaction request
result.code
PayOn specific result code for the transaction
result.avsResponse
Contains the AVS response returned by the acquirer. It may include one the following results:
A = Address does match, zip code does not match
Z = Address does not match, zip code does match
N = Address and zip code do not match
U = Technical or logical error. AVS cannot be applied on card or address (not UK or US issuer), issuer is not available, etc.
F = Address and Postal Code Matches
result.cvvResponse
AVS result on the card holders CV2
response.description
A textual description explaining the result.code's meaning    
resultDetails
A container for name value pair used for enriching the response with bank-specific response details (i.e.; the actual parameters used within resultDetails are bank-specific
resultDetails.AcquirerResponse
Represents the acquirer original response code retrieved from the acquirer directly
card.bin
Returns the first six digits of the card used for the transaction
card.last4Digits
Returns the last four digits of the card used for the transaction
card.holder
Returns the name of the card holder, in line with the card.holder sent in with the transaction
card.expiryMonth
Returns the expiry month of the card used for the transaction
card.expiryYear
Returns the expiry year of the card used for the transaction
risk.score
Returns the score of the executed transaction risk checks. The value is a number from -99999 to +99999. Can be returned both for standalone risk requests and payment requests that include risk checks
buildNumber
Build number that PayOn are currently on. Useful for support purposes
timestamp
Timestamp of the time of the transaction
ndc
An internal unique identifier for the request
merchantTransactionId
Returns the specified transaction id which is client specific
billing.street1
Billing address Line 1 - will only be returned if the billing inputs have been entered
billing.street2
Billing address Line 2 (Optional) - will only be returned if the billing inputs have been entered
billing.city
Billing city - will only be returned if the billing inputs have been entered
billing.postcode
Billing postcode - will only be returned if the billing inputs have been entered
billing.country
Billing country - will only be returned if the billing inputs have been entered
customer.merchantCustomerId
Customer merchant ID - will only be returned if the customer inputs have been entered
customer.givenName
Customer given name - will only be returned if the customer inputs have been entered
customer.middleName
Customer middle name - will only be returned if the customer inputs have been entered
customer.surname
Customer surname - will only be returned if the customer inputs have been entered
customer.birthDate
Customer date of birth - will only be returned if the customer inputs have been entered
customer.phone
Customer phone number - will only be returned if the customer inputs have been entered
customer.mobile
Customer mobile number - will only be returned if the customer inputs have been entered
customer.workPhone
Customer work phone number - will only be returned if the customer inputs have been entered
customer.email
Customer email address - will only be returned if the customer inputs have been entered
customer.companyName
Customer company name - will only be returned if the customer inputs have been entered
customer.identificationDocType
Customer ID document type (one of the specified types on the input) - will only be returned if the customer inputs have been entered
customer.identificationDocId
Customer ID document ID (the ID which relates back to the specific doc type) - will only be returned if the customer inputs have been entered
customer.ip
Customer IP address - will only be returned if the customer inputs have been entered
customer.status
Customer Status (new or existing) - will only be returned if the customer inputs have been entered
resultDetails.ExtendedDescription
Additional resultDetails field, contains information about the result of the transaction
resultDetails.ConnectorTxID1
Additional resultDetails field, contains information about the result of the transaction
resultDetails.ConnectorTxID3
Additional resultDetails field, contains information about the result of the transaction
resultDetails.reconciliationId
Additional resultDetails field, contains information about the result of the transaction
shipping.street1
Shipping address line 1 - only returned if the shipping inputs have been entered
shipping.street2
Shipping address line 2 (optional) - only returned if the shipping inputs have been entered
shipping.city
Shipping city - only  returned if the shipping inputs have been entered
shipping.state
Shipping state (optional) - only returned if the shipping inputs have been entered
shipping.postcode
Shipping postcode - only returned if the shipping inputs have been entered
shipping.country
Shipping country - will only be returned if the shipping inputs have been entered
shipping.method
Shipping method (optional) - will only be returned if the shipping inputs have been entered
shipping.comment
 Shipping comment (optional) - will only be returned if the shipping inputs have been entered
errorMessage
PCI Pal specific error message.  Should any errors occur our internal error handling will respond with a message on the output of the flow
 
PayOn Logic Item
The PayOn Logic Item contains the following properties:
 
PayOn Payment Gateway
1

Authorisation User ID

The userId for the entity.  Required to authenticate a server-to-server request.
2

Authorisation Password

The password for the userId. Required to authenticate a server-to-server request.
3

Authorisation Entity ID

The entity for the request. By default this is the channel's ID.  It can be the division, merchant or channel identifier. Division is for requesting registrations only, merchant only in combination with channel dispatching, i.e. channel is the default for sending payment transactions.
4

Success Code

Each gateway has its own unique selection of status codes on a request back from the gateway - for PayOn, these are listed in the page linked below:
 
Result codes
 
This must be set in order for our internal logging processes to notice that the payment has come back with the expected response.
5

Select Endpoint

  For added security the PayOn endpoints have been hardcoded into the integration.  Test or Live needs to be selected from the Select Endpoint drop down list, depending on the transaction being conducted.
 
Further information can be found by viewing the integration documentation:
 
PayOn Integration Documentation
 
The help manual was created with Dr.Explain