Below is a description of the variables that comprise the input API of the payment form. This request may yield either a 3D Secure “Authentication Required” response or a “Payment Complete” response.<\/p>\n
<\/p>\n
| \n Input Field Name<\/p>\n<\/td>\n | \n Data Type<\/p>\n<\/td>\n | \n Max Length<\/p>\n<\/td>\n | \n Mandatory or Always Present<\/p>\n<\/td>\n | \n Comments<\/p>\n<\/td>\n<\/tr>\n |
| \n HashDigest<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n –<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n A hashed string that contains all the variables passed and also data that is not passed but is known to both sides – namely the PreSharedKey and the gateway account password. (see section below)<\/p>\n<\/td>\n<\/tr>\n |
| \n MerchantID<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 15<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The merchant ID that corresponds to the gateway account the transaction will be run through. NOTE: If this variable is not present, then the skinning of the payment form will not happen<\/p>\n<\/td>\n<\/tr>\n |
| \n Amount<\/p>\n<\/td>\n | \n N<\/p>\n<\/td>\n | \n 13<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The transaction amount in minor currency – e.g. for £10.00, it must be submitted as 1000<\/p>\n<\/td>\n<\/tr>\n |
| \n CurrencyCode<\/p>\n<\/td>\n | \n N<\/p>\n<\/td>\n | \n 3<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The currency of the transaction. ISO 4217<\/p>\n e.g. GBP: 826<\/p>\n<\/td>\n<\/tr>\n |
| \n EchoAVSCheckResult<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Instructs the payment form to include the AVS check result of the transaction in the output variables<\/p>\n<\/td>\n<\/tr>\n |
| \n EchoCV2CheckResult<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Instructs the payment form to include the CV2 check result of the transaction in the output variables<\/p>\n<\/td>\n<\/tr>\n |
| \n EchoThreeDSecureAuthenticationCheckResult<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Instructs the payment form to include the 3D Secure check result of the transaction in the output variables<\/p>\n<\/td>\n<\/tr>\n |
| \n EchoFraudProtectionCheckResult<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Instructs the payment form to include the Fraud protection check result of the transaction<\/p>\n<\/td>\n<\/tr>\n |
| \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n in the output variables<\/p>\n<\/td>\n<\/tr>\n |
| \n EchoCardType<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Instructs the payment form to include the card type of the transaction in the output variables<\/p>\n<\/td>\n<\/tr>\n |
| \n AVSOverridePolicy<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 4<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Sets the override AVS checking policy for this transaction<\/p>\n<\/td>\n<\/tr>\n |
| \n CV2OverridePolicy<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Sets the CV2 checking policy for this transaction<\/p>\n<\/td>\n<\/tr>\n |
| \n ThreeDSecureOverridePolicy<\/p>\n<\/td>\n | \n B<\/p>\n<\/td>\n | \n true\/false<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Instructs the payment form to enable\/disable the 3D Secure checking for this transaction (where possible)<\/p>\n<\/td>\n<\/tr>\n |
| \n OrderID<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n A merchant side ID for the order – primarily used to for determining duplicate transactions. Note: make sure that special characters in the OrderID are properly escaped, otherwise the hash digest will not match<\/p>\n<\/td>\n<\/tr>\n |
| \n TransactionType<\/p>\n<\/td>\n | \n –<\/p>\n<\/td>\n | \n –<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n Must be either SALE or<\/p>\n PREAUTH<\/p>\n<\/td>\n<\/tr>\n |
| \n TransactionDateTime<\/p>\n<\/td>\n | \n DT<\/p>\n<\/td>\n | \n –<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The date & time (as seen by the merchant’s server) of the transaction. Needs to be in the form “YYYY- MM-DD HH:MM:SS +00:00”, with the time in 24 hour format, where 00:00 is the offset from UTC – e.g. “2008-12-01 14:12:00 +01:00”<\/p>\n<\/td>\n<\/tr>\n |
| \n CallbackURL<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n –<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The URL of the page on the merchant’s site that the results of the transaction will be posted back to (see section below)<\/p>\n<\/td>\n<\/tr>\n |
| \n OrderDescription<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 256<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n A description for the order. Note: make sure that special characters in the OrderDescription are properly escaped, otherwise the hash digest will not match<\/p>\n<\/td>\n<\/tr>\n |
| \n Address1<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 100<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address line 1<\/p>\n<\/td>\n<\/tr>\n |
| \n Address2<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing<\/p>\n<\/td>\n<\/tr>\n |
| \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n <\/p>\n<\/td>\n | \n address line 2<\/p>\n<\/td>\n<\/tr>\n |
| \n Address3<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address line 3<\/p>\n<\/td>\n<\/tr>\n |
| \n Address4<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address line 4<\/p>\n<\/td>\n<\/tr>\n |
| \n City<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address city<\/p>\n<\/td>\n<\/tr>\n |
| \n State<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address state<\/p>\n<\/td>\n<\/tr>\n |
| \n PostCode<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 50<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing address post code<\/p>\n<\/td>\n<\/tr>\n |
| \n CountryCode<\/p>\n<\/td>\n | \n N<\/p>\n<\/td>\n | \n 3<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s billing country code. ISO 3166- 1 e.g. United Kingdom: 826<\/p>\n<\/td>\n<\/tr>\n |
| \n EmailAddress<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 100<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s email<\/p>\n address<\/p>\n<\/td>\n<\/tr>\n |
| \n PhoneNumber<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 30<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n Customer’s phone number<\/p>\n<\/td>\n<\/tr>\n |
| \n CardName<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 100<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The cardholder’s name as it appears on the front of the card<\/p>\n<\/td>\n<\/tr>\n |
| \n CardNumber<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 19<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The full card number as it appears on the front of the card<\/p>\n<\/td>\n<\/tr>\n |
| \n ExpiryDateMonth<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The first 2 digits from the card’s expiry date representing the month part of the expiry date<\/p>\n e.g. 02\/12 where 02 is the card’s expiry month<\/p>\n<\/td>\n<\/tr>\n |
| \n ExpiryDateYear<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n Yes<\/p>\n<\/td>\n | \n The last 2 digits from the card’s expiry date representing the year part of the expiry date<\/p>\n e.g. 02\/12 where 12 is the card’s expiry year of 2012<\/p>\n<\/td>\n<\/tr>\n |
| \n StartDateMonth<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n The first 2 digits from the card’s start date representing the month part of the start date<\/p>\n e.g. 01\/09 where 01 is the card’s start month<\/p>\n<\/td>\n<\/tr>\n |
| \n StartDateYear<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n The last 2 digits from card’s start date representing the year part of the start date<\/p>\n e.g. 01\/09 where 09 is the card’s start year of 2009<\/p>\n<\/td>\n<\/tr>\n |
| \n IssueNumber<\/p>\n<\/td>\n | \n A<\/p>\n<\/td>\n | \n 2<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n The card’s issue number as it appears on the front on the card<\/p>\n<\/td>\n<\/tr>\n |
| \n CV2<\/p>\n<\/td>\n | \n N<\/p>\n<\/td>\n | \n 3<\/p>\n<\/td>\n | \n No<\/p>\n<\/td>\n | \n The card’s CV2 number<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":" Below is a description of the variables that comprise the input API of the payment form. This request may yield either a 3D Secure “Authentication Required” response or a “Payment Complete” response. Input Field Name Data Type Max Length Mandatory or Always Present Comments HashDigest A – Yes A hashed string that contains all…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[9],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/272"}],"collection":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/comments?post=272"}],"version-history":[{"count":3,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/272\/revisions"}],"predecessor-version":[{"id":281,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/272\/revisions\/281"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=272"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=272"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=272"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}} |