{"id":89,"date":"2021-07-21T15:15:37","date_gmt":"2021-07-21T15:15:37","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=89"},"modified":"2021-07-21T15:15:37","modified_gmt":"2021-07-21T15:15:37","slug":"output-variables","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/hosted-payment-form\/output-variables\/","title":{"rendered":"Output Variables"},"content":{"rendered":"

Below is a description of the variables which will be posted back to the Merchants CallbackURL. These comprise the output API of the payment form.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Variable<\/strong><\/span> Name<\/strong><\/span><\/span><\/td>\nData<\/strong><\/span> Type<\/strong><\/span><\/span><\/td>\nMax<\/strong><\/span> Length<\/strong><\/span><\/span><\/td>\nComments<\/strong><\/span><\/span><\/td>\n<\/tr>\n
HashDigest<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

A hashed string that contains all the<\/span> variables passed and also data that is not<\/span> passed but is known to both sides – namely<\/span> the PreSharedKey and the gateway account<\/span> password. (see<\/span> section<\/span> below)<\/span><\/span><\/td>\n<\/tr>\n
MerchantID<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

15<\/span><\/span><\/p>\n<\/td>\n

The<\/span> merchant<\/span> ID<\/span> that<\/span> was<\/span> used<\/span> to<\/span> process<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
StatusCode<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

This<\/span> indicates<\/span> the<\/span> status<\/span> of<\/span> the<\/span> transaction:<\/span><\/span><\/p>\n
    \n
  • \n

    0:<\/span> transaction<\/span> successful<\/span><\/span><\/p>\n<\/li>\n

  • \n

    4:<\/span> card<\/span> referred<\/span><\/span><\/p>\n<\/li>\n

  • \n

    5:<\/span> card<\/span> declined<\/span><\/span><\/p>\n<\/li>\n

  • \n

    20:<\/span> duplicate<\/span> transaction<\/span><\/span><\/p>\n<\/li>\n

  • \n

    30:<\/span> exception<\/span><\/span><\/p>\n<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n

Message<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

512<\/span><\/span><\/p>\n<\/td>\n

This gives a more detailed description of<\/span> the<\/span> status<\/span> of<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
PreviousStatusCode<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

If the transaction was deemed to be a<\/span> duplicate<\/span> transaction,<\/span> this<\/span> indicates<\/span> the<\/span> status<\/span> of<\/span> the<\/span> previous<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
PreviousMessage<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

512<\/span><\/span><\/p>\n<\/td>\n

If the transaction was deemed to be a<\/span> duplicate transaction, this gives a more<\/span> detailed<\/span> description<\/span> of<\/span> the<\/span> status<\/span> of<\/span> the<\/span> previous<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
CrossReference<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

24<\/span><\/span><\/p>\n<\/td>\n

This is the unique cross reference for this<\/span> transaction.<\/span> If<\/span> the<\/span> transaction<\/span> was<\/span> determined<\/span> to be a duplicate transaction, this value will<\/span> hold<\/span> the<\/span> cross reference<\/span> of<\/span> the<\/span> previous<\/span> transaction (which this transaction was<\/span> deemed<\/span> a duplicate<\/span><\/span><\/td>\n<\/tr>\n
AddressNumericCheckResult<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

If requested (input variable<\/span> “EchoAVSCheckResult = true”) this gives the<\/span> results of the address numeric check \u2013 will<\/span> be PASSED, FAILED, PARTIAL, NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n
PostCodeCheckResult<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

If requested (input variable<\/span> “EchoAVSCheckResult = true”) this gives the<\/span> results of the post code check \u2013 will be<\/span> PASSED, FAILED, PARTIAL, NOT_CHECKED or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n
CV2CheckResult<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

–<\/span><\/span><\/p>\n<\/td>\n

If requested (input variable<\/span> “EchoCV2CheckResult<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span> the<\/span> results of the CV2 check \u2013 will be PASSED,<\/span> FAILED, NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ThreeDSecureAuthenticationCheckResult<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoThreeDSecureAuthenticationCheckRe<\/span> sult = true”) this gives the results of the 3D<\/span> Secure check – will be PASSED, FAILED,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/td>\n<\/tr>\n
FraudProtectionCheckResult<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoFraudProtectionCheckResult = true”)<\/span> this gives the results of the Fraud protection<\/span> check – will be PASSED, FAILED, CHALLENGE<\/span> or<\/span> ERROR<\/span><\/span><\/td>\n<\/tr>\n
CardType<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoCardType<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span> the<\/span><\/span><\/p>\n

card<\/span> type<\/span> of<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n

CardClass<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoCardType<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span> the<\/span><\/span><\/p>\n

card<\/span> class<\/span> of<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n

CardIssuer<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nIf<\/span> requested<\/span> (input variable<\/span> “EchoCardType<\/span> =<\/span> true”)<\/span> this gives the<\/span> card<\/span> issuer<\/span> (if<\/span> known)<\/span><\/span><\/td>\n<\/tr>\n
CardIssuerCountryCode<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

3<\/span><\/span><\/td>\nIf<\/span> requested<\/span> (input<\/span> variable<\/span> “EchoCardType<\/span><\/span><\/p>\n

=<\/span> true”)<\/span> this<\/span> gives<\/span> the<\/span> 3<\/span> digit<\/span> code of<\/span> the<\/span><\/span><\/p>\n

country<\/span> the<\/span> card<\/span> was<\/span> issued<\/span> in<\/span> (if<\/span> known)<\/span><\/span><\/td>\n<\/tr>\n

CardNumberFirstSix<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

6<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoCardNumberFirstSix<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span> the first 6 digits of the card number of the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
CardNumberLastFour<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

4<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoCardNumberLastFour = true”) this<\/span> gives the last 4 digits of the card number of<\/span> the<\/span> transaction<\/span><\/span><\/td>\n<\/tr>\n
CardExpiryDate<\/span><\/span><\/td>\n\n

DT<\/span><\/span><\/p>\n<\/td>\n

5<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoCardExpiryDate<\/span> =<\/span> true”) this<\/span> gives<\/span> the<\/span> expiry date of the card of the transaction.<\/span> Will<\/span> be<\/span> in<\/span> the<\/span> form<\/span> “MM\/YY”<\/span> e.g.<\/span> “12\/14”<\/span><\/span><\/td>\n<\/tr>\n
Amount<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

13<\/span><\/span><\/td>\nThe<\/span> amount,<\/span> in<\/span> minor<\/span> currency,<\/span> of<\/span> the<\/span><\/span><\/p>\n

transaction<\/span> that<\/span> was<\/span> processed<\/span><\/span><\/td>\n<\/tr>\n

DonationAmount<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

13<\/span><\/span><\/td>\nIf requested (input variable<\/span> “EchoDonationAmount<\/span> =<\/span> true”)<\/span> this<\/span> gives<\/span><\/span><\/p>\n

the<\/span> donation<\/span> amount<\/span> in<\/span> minor<\/span> currency<\/span><\/span><\/td>\n<\/tr>\n

CurrencyCode<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

3<\/span><\/span><\/td>\nThe<\/span> currency code<\/span> of<\/span> the<\/span> transaction<\/span> that<\/span><\/span><\/p>\n

was<\/span> processed. ISO<\/span> 4217<\/span> e.g. GBP:<\/span> 826<\/span><\/span><\/td>\n<\/tr>\n

OrderID<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

50<\/span><\/span><\/td>\nThe order ID of the transaction that was<\/span> processed. Note: make sure that special<\/span> characters in the OrderID are properly<\/span> escaped, otherwise the hash digest will not<\/span> match<\/span><\/span><\/td>\n<\/tr>\n
TransactionType<\/span><\/span><\/td>\n\n

–<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nThe<\/span> transaction<\/span> type<\/span> of<\/span> the<\/span> transaction<\/span> that<\/span><\/span><\/p>\n

was processed. Will be either SALE or<\/span> PREAUTH<\/span><\/span><\/td>\n<\/tr>\n

TransactionDateTime<\/span><\/span><\/td>\n\n

DT<\/span><\/span><\/p>\n<\/td>\n

–<\/span><\/span><\/td>\nThe date & time (as seen by the gateway<\/span> server) of the transaction. Will be in the<\/span> form<\/span> “YYYY-MM-DD<\/span> HH:MM:SS<\/span> \u00b1OO:OO”,<\/span><\/span><\/p>\n

with the time in 24 hour format, where<\/span> OO:OO<\/span> is<\/span> the<\/span> offset<\/span> from<\/span> UTC<\/span> –<\/span> e.g.<\/span> “2008-<\/span><\/span><\/p>\n

12-01<\/span> 14:12:00<\/span> +01:00″<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
OrderDescription<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

256<\/span><\/span><\/p>\n<\/td>\n

The order description of the transaction that<\/span> was processed. Note: make sure that special<\/span> characters in the OrderDescription are<\/span> properly escaped, otherwise the hash digest<\/span> will<\/span> not match<\/span><\/span><\/td>\n<\/tr>\n
CustomerName<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

The<\/span> name<\/span> of<\/span> the<\/span> customer<\/span> as it was<\/span><\/span><\/p>\n

submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n

Address1<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

Customer’s billing address line 1 as it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
Address2<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s billing address line 2 as it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
Address3<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s billing address line 3 as it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
Address4<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s billing address line 4 as it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
City<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s<\/span> billing<\/span> city<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
State<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s<\/span> billing<\/span> state<\/span> as<\/span> it<\/span> was submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PostCode<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

Customer’s<\/span> billing<\/span> post code<\/span> as<\/span> it was<\/span><\/span><\/p>\n

submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n

CountryCode<\/span><\/span><\/td>\n\n

N<\/span><\/span><\/p>\n<\/td>\n

\n

3<\/span><\/span><\/p>\n<\/td>\n

Customer’s<\/span> billing country<\/span> code<\/span> as<\/span> it<\/span> was<\/span><\/span><\/p>\n

submitted to the gateway. ISO 3166-1 e.g.<\/span> United<\/span> Kingdom:<\/span> 826<\/span><\/span><\/td>\n<\/tr>\n

EmailAddress<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

The<\/span> customer’s<\/span> email<\/span> address as<\/span> it<\/span> was<\/span><\/span><\/p>\n

submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n

PhoneNumber<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

30<\/span><\/span><\/p>\n<\/td>\n

The<\/span> customer’s<\/span> phone<\/span> number<\/span> as<\/span> it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
DateOfBirth<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

30<\/span><\/span><\/p>\n<\/td>\n

The<\/span> customer’s<\/span> date<\/span> of<\/span> birth<\/span> as<\/span> it was<\/span><\/span><\/p>\n

submitted to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n

PrimaryAccountName<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

100<\/span><\/span><\/p>\n<\/td>\n

The<\/span> name<\/span> of<\/span> the<\/span> primary<\/span> account<\/span> holder<\/span> as<\/span> it<\/span> was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountNumber<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

The account number of the primary<\/span> account<\/span> as<\/span> it was<\/span> submitted<\/span> to<\/span> the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountDateOfBirth<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

10<\/span><\/span><\/p>\n<\/td>\n

The date of birth of the primary account<\/span> holder<\/span> as<\/span> it<\/span> was submitted to the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n
PrimaryAccountPostCode<\/span><\/span><\/td>\n\n

A<\/span><\/span><\/p>\n<\/td>\n

\n

50<\/span><\/span><\/p>\n<\/td>\n

The post code of the primary account<\/span> holder<\/span> as<\/span> it<\/span> was submitted to the<\/span> gateway<\/span><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

<\/h2>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

Below is a description of the variables which will be posted back to the Merchants CallbackURL. These comprise the output API of the payment form. Variable Name Data Type Max Length Comments HashDigest A – A hashed string that contains all the variables passed and also data that is not passed but is known to…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[4,31],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/89"}],"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=89"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/89\/revisions"}],"predecessor-version":[{"id":90,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/89\/revisions\/90"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=89"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=89"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=89"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}