|
Input Fields
|
Required
|
Character Limits/
Required Input
|
Description
|
|
username
|
No (C)
|
n/a
|
Unique username provided to the client by BPoint
|
|
merchantId
|
No (C)
|
n/a
|
Unique merchant ID provided to the client by BPoint
|
|
password
|
No (C)
|
n/a
|
Unique password provided to the client by BPoint
|
|
WebHookUrl
|
No
|
n/a
|
Merchant web hook handler URL
|
|
RedirectionUrl
|
No
|
n/a
|
Merchant receipt redirection URL
|
|
TestMode
|
No
|
boolean
|
Whether or not test mode is being used, values are:
- true
- false
|
|
Action
|
Yes
|
n/a
|
The following must be used to specify the type of transaction:
- payment
- unmatched_refund
- preauth
- capture
|
|
BillerCode
|
No
|
50 chars
|
Biller code for the transaction
|
|
MerchantReference
|
No
|
50 chars
|
Reference that is for internal use only
|
|
Crn1
|
Yes
|
50 chars
|
This field should be unique for each payment
|
|
Crn2
|
No
|
50 chars
|
Additional crn field
|
|
Crn3
|
No
|
50 chars
|
Additional crn field
|
|
Currency
|
Yes
|
3 chars
|
The three-character currency for the transaction, e.g. GBP, EUR, USD, AUD
|
|
Amount
|
Yes
|
n/a
|
The amount for the transaction
|
|
AmountOriginal
|
No
|
n/a
|
Total payment amount without surcharge - this field is for information and reporting only and does not alter the value of the transaction (as specified by Amount)
|
|
AmountSurcharge
|
No
|
n/a
|
Surcharge amount for payment - this field is for information and reporting only and does not alter the value of the transaction (as specified by Amount)
|
|
TokenisationMode
|
No
|
1 num
|
Determines whether or not tokenisation of the payment instrument will occur:
- 0 Default
- 1 Do not tokenise
- 2 Tokenise if customer opts in
- 3 Always tokenise
|
|
AmexExpressCheckout
|
No
|
20 chars
|
A person name's infix, if applicable
|
|
BypassThreeDS
|
No
|
4 chars
|
Should always be set to true, PCI Pal do not support 3DS.
|
|
SubType
|
Yes
|
9 chars
|
Defines a sub type for transaction:
- single Used for one-off transactions
- recurring Used when the merchant regularly debits the account, e.g. monthly billing. Note, recurring payments are only supported for Visa, MasterCard, American Express, Diner's Club and JCB cards
|
|
CustomerDateOfBirth
|
No
|
8 num
|
Date of birth in the format DDMMYYYY
|
|
CustomerFirstName
|
No
|
n/a
|
First name
|
|
CustomerLastName
|
No
|
n/a
|
Last name
|
|
CustomerMiddleName
|
No
|
n/a
|
Middle name
|
|
CustomerSalutation
|
No
|
n/a
|
Salutation
|
|
CustomerEmailAddress
|
No
|
n/a
|
Email Address
|
|
CustomerFaxNumber
|
No
|
n/a
|
Fax Number
|
|
CustomerHomePhoneNumber
|
No
|
n/a
|
Customer Home Phone Number
|
|
CustomerMobilePhoneNumber
|
No
|
n/a
|
Customer Mobile Phone Number
|
|
CustomerWorkPhoneNumber
|
No
|
n/a
|
Customer Work Phone Number
|
|
CustomerAddressLine1
|
Yes
|
n/a
|
First line of address
|
|
CustomerAddressLine2
|
No
|
n/a
|
Second line of address
|
|
CustomerAddressLine3
|
No
|
n/a
|
Third line of address
|
|
CustomerCity
|
No
|
n/a
|
City of the address
|
|
CustomerCountryCode
|
No
|
n/a
|
Country Code of the address
|
|
CustomerPostCode
|
No
|
n/a
|
Post code of the address
|
|
CustomerState
|
No
|
n/a
|
State of the address
|
|
CustomerComments
|
No
|
n/a
|
Comment regarding to the customer information
|
|
ShippingDateOfBirth
|
No
|
8 num
|
Date of birth in the format DDMMYYYY
|
|
ShippingFirstName
|
No
|
n/a
|
First name
|
|
ShippingLastName
|
No
|
n/a
|
Last name
|
|
ShippingMiddleName
|
No
|
n/a
|
Middle name
|
|
ShippingSalutation
|
No
|
n/a
|
Salutation
|
|
ShippingEmailAddress
|
No
|
n/a
|
Email Address
|
|
ShippingFaxNumber
|
No
|
n/a
|
Fax Number
|
|
ShippingHomePhoneNumber
|
No
|
n/a
|
Shipping Home Phone Number
|
|
ShippingMobilePhoneNumber
|
No
|
n/a
|
Shipping Mobile Phone Number
|
|
ShippingWorkPhoneNumber
|
No
|
n/a
|
Shipping Work Phone Number
|
|
ShippingAddressLine1
|
No
|
n/a
|
First line of address
|
|
ShippingAddressLine2
|
No
|
n/a
|
Second line of address
|
|
ShippingAddressLine3
|
No
|
n/a
|
Third line of address
|
|
ShippingCity
|
No
|
n/a
|
City of the address
|
|
ShippingCountryCode
|
No
|
n/a
|
Country Code of the address
|
|
ShippingPostCode
|
No
|
n/a
|
Post code of the address
|
|
ShippingState
|
No
|
n/a
|
State of the address
|
|
ShippingComments
|
No
|
n/a
|
Comment regarding to the shipping information
|
|
BillingDateOfBirth
|
No
|
8 num
|
Date of birth in the format DDMMYYYY
|
|
BillingFirstName
|
No
|
n/a
|
First name
|
|
BillingLastName
|
No
|
n/a
|
Last name
|
|
BillingMiddleName
|
No
|
n/a
|
Middle name
|
|
BillingSalutation
|
No
|
n/a
|
Salutation
|
|
BillingEmailAddress
|
No
|
n/a
|
Email Address
|
|
BillingFaxNumber
|
No
|
n/a
|
Fax Number
|
|
BillingHomePhoneNumber
|
No
|
n/a
|
Billing Home Phone Number
|
|
BillingMobilePhoneNumber
|
No
|
n/a
|
Billing Mobile Phone Number
|
|
BillingWorkPhoneNumber
|
No
|
n/a
|
Billing Work Phone Number
|
|
BillingAddressLine1
|
No
|
n/a
|
First line of address
|
|
BillingAddressLine2
|
No
|
n/a
|
Second line of address
|
|
BillingAddressLine3
|
No
|
n/a
|
Third line of address
|
|
BillingCity
|
No
|
n/a
|
City of the address
|
|
BillingCountryCode
|
No
|
n/a
|
Country Code of the address
|
|
BillingPostCode
|
No
|
n/a
|
Post code of the address
|
|
BillingState
|
No
|
n/a
|
State of the address
|
|
BillingComments
|
No
|
n/a
|
Comment regarding to the billing information
|
|
ShippingMethod
|
Yes
|
n/a
|
Method of shipping for the item:
- Next_Day_Service
- Two_Day_Service
- Three_Day_Service
- Low_Cost_Carrier
- Customer_Choice
- Military
- Collect_At_Store
- Other
|
|
CardHolderName
|
No
|
50 chars
|
Cardholder name
|
|
OriginalTxnNumber
|
No
|
50 chars
|
Used for refunds, reversals and captures.
For refunds: transaction number of the payment or capture being refunded.
For reversals: transaction number of the payment, refund, preauth, capture or unmatched_refund that is being reversed.
For captures: transaction number of preauth that is being captured.
MANDATORY when action is refund, reversal or capture, otherwise NOT REQUIRED and will be ignored
|
|
EmailAddress
|
No
|
n/a
|
Customer email address
|
|
DVToken
|
Auth key Only
|
n/a
|
System generated dvtoken. Tokens can be used in place of a card number to process transactions using the payment details saved for that dvtoken Only returned if tokenisation is requested
|
|
UpdateDVTokenExpiryDate
|
Auth key Only
|
boolean
|
true or false value
|
|
TokeniseTxnCheckBoxDefaultValue
|
Auth key Only
|
boolean
|
Sets the default value for the tokenisation check box
|
|
ApiKey
|
No
|
|
|
|
RedirectUrl
|
Auth key Only
|
|
Merchant receipt redirection URL
|
|
paymentType
|
Yes
|
n/a
|
This should be set to either:
- twoParty
- threeParty
- authKey
|
|
Type
|
Yes
|
n/a
|
Needs to be set to either:
- callcentre
- ivr
- telephoneorder
|
