{"id":512,"date":"2021-07-30T14:27:22","date_gmt":"2021-07-30T14:27:22","guid":{"rendered":"https:\/\/payb.co.uk\/integration-guide\/?p=512"},"modified":"2021-07-30T14:27:22","modified_gmt":"2021-07-30T14:27:22","slug":"response","status":"publish","type":"post","link":"https:\/\/payb.co.uk\/integration-guide\/direct-integration\/response\/","title":{"rendered":"Response"},"content":{"rendered":"

Below are the details for the response that will be received after sending a CardDetailsTransaction request.<\/p>\n

\n\n\n<\/colgroup>\n\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Tag\/Attribute<\/span> Name<\/span><\/span><\/p>\n<\/td>\n

\n

Data<\/span><\/span><\/p>\n

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

\n

Max<\/span><\/span><\/p>\n

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

\n

Always<\/span><\/span><\/p>\n

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

\n

Comments<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

CardDetailsTransactionResponse<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CardDetailsTransactionResult<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

AuthorisationAttempted<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

This indicates whether the<\/span> transaction was actually sent<\/span> to the acquirer for<\/span> authorisation,<\/span> or<\/span> whether<\/span> it<\/span><\/span><\/p>\n

failed<\/span> before<\/span> authorisation<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

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

\n

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

the<\/span> transaction<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

ErrorMessages<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

MessageDetail<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Detail<\/span> (multiple)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

If there were multiple error<\/span> messages(e.g.multipleinput<\/span> variable validation errors,<\/span> then<\/span> they<\/span> will<\/span> be<\/span> detailed<\/span><\/span><\/p>\n

here)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

PreviousTransactionResult<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

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

\n

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

\n

\n<\/td>\n

\n

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

\n

If the transaction was<\/span> deemed to be a duplicate<\/span> transaction,<\/span> this<\/span> givesamore<\/span> detailed description of the<\/span> status<\/span> of<\/span> the<\/span> previous<\/span><\/span><\/p>\n

transaction<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

TransactionOutputData<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CrossReference<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

This is the unique cross<\/span> reference for this transaction.<\/span> If the card has been<\/span> determined as requiring 3D<\/span> Secure authentication this<\/span> must be used as the merchant<\/span> reference. If the transaction<\/span> required 3D Secure<\/span> authentication, then this must<\/span> be passed to the ACS as \u2018MD\u2019.<\/span> If the transaction was rejected<\/span> as a duplicate transaction, this<\/span> value will hold the cross<\/span> reference<\/span> of the<\/span> previous<\/span><\/span><\/p>\n

transaction<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

ExternalCrossReference<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the unique cross reference of<\/span> the<\/span> transaction<\/span> from<\/span> the<\/span><\/span><\/p>\n

bank\u2019s external system passed<\/span> back to the Payment Gateway.<\/span> If the card has been<\/span> determined as requiring 3D<\/span> Secure authentication this will<\/span> not be present in the<\/span> response.<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ExternalClientReference<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the unique client reference of<\/span> the<\/span> transaction<\/span> from<\/span> the<\/span><\/span><\/p>\n

bank\u2019s external system passed<\/span> back to the Payment Gateway.<\/span> If the card has been<\/span> determined as requiring 3D<\/span> Secure authentication this will<\/span> not be present in the<\/span> response.<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ExternalTransactionUID<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the unique identifier of the<\/span> transaction from the bank\u2019s<\/span> external system passed back<\/span> to the Payment Gateway. If<\/span> the card has been determined<\/span> as requiring 3D Secure<\/span> authentication this will not be<\/span> present<\/span> in<\/span> the response.<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If<\/span> the transaction<\/span> was<\/span><\/span><\/p>\n

successful,<\/span> then<\/span> the<\/span> auth<\/span> code is<\/span> passed<\/span> out<\/span> here<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the results of the address<\/span> numeric check \u2013 will be<\/span> PASSED, FAILED, PARTIAL,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n<\/colgroup>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the results of the post code<\/span> check \u2013 will be PASSED,<\/span> FAILED, PARTIAL,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the results of the CV2check \u2013<\/span> will be PASSED, FAILED,<\/span> NOT_CHECKED<\/span> or<\/span> UNKNOWN<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

CardTypeData<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the card type for the<\/span> transaction. (See Appendix 4<\/span> for<\/span> details)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

The<\/span> card<\/span> issuer<\/span> (if<\/span> known)<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If requested in the<\/span> CardDetailsTransaction<\/span> request message, this gives<\/span> the<\/span> amount<\/span> that<\/span> was<\/span> passed<\/span> to the gateway via the request<\/span> message<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

ThreeDSecureOutputData<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

No<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If the card has been<\/span> determined as requiring 3D<\/span> Secure authentication, this<\/span> gives the base64 encoded<\/span> payment request that must be<\/span> passed to the ACS for<\/span> authentication. This must be<\/span> sent<\/span> to<\/span> the<\/span> ACS<\/span> as<\/span> \u2018PaReq\u2019<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

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

\n

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

\n

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

\n

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

\n

If the card has been<\/span> determined as requiring 3D<\/span> Secure authentication, this<\/span> gives the<\/span> URL<\/span> of<\/span> the<\/span> ACS<\/span> server<\/span> that<\/span> the<\/span> PaREQ<\/span> must<\/span> be<\/span><\/span><\/p>\n

sent<\/span> to<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

GatewayEntryPoints<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

\n<\/td>\n

\n

GatewayEntryPoint<\/strong><\/span> (multiple)<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

Yes<\/strong><\/span><\/span><\/p>\n<\/td>\n

\n

\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

EntryPointURL<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

The<\/span> URL<\/span> of<\/span> the<\/span> active<\/span><\/span><\/p>\n

gateway<\/span> entry point<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n

\n

\n<\/td>\n

\n

Metric<\/span> (attribute)<\/span><\/span><\/p>\n<\/td>\n

\n

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

\n

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

\n

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

\n

A metric value giving an<\/span> indication of whether<\/span> transactions should be sent to<\/span> this<\/span> gateway<\/span> entry point<\/span><\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

\n

<\/a> Things<\/span> to<\/span> Note<\/span><\/h3>\n
    \n
  • \n

    If requested, the AmountReceived will always echo the amount passed to the gateway in the<\/span> CardDetailsTransaction<\/span> message,<\/span> regardless<\/span> of<\/span> the<\/span> outcome<\/span> of<\/span> the<\/span> transaction<\/span> (apart<\/span> from<\/span> if<\/span> the<\/span> message<\/span> could<\/span> not<\/span> be<\/span> validated<\/span> due<\/span> to<\/span> content<\/span> errors)<\/span><\/span><\/p>\n<\/li>\n

  • \n

    If the CV2 is not submitted in the CardDetailsTransaction message, then the CV2CheckResult<\/span> returned<\/span> in<\/span> the<\/span> CardDetailsTransactionResponse<\/span> will<\/span> be<\/span> deemed<\/span> as<\/span> UNKNOWN,<\/span> rather<\/span> than<\/span> FAILED<\/span><\/span><\/p>\n<\/li>\n

  • \n

    If the address or the post code information is not submitted in the CardDetailsTransaction<\/span> message,<\/span> then<\/span> the<\/span> AddressNumericCheckResult<\/span> and\/or<\/span> the<\/span> PostCodeCheckResult<\/span> returned<\/span> in<\/span> the<\/span> CardDetailsTransactionResponse<\/span> will<\/span> be<\/span> deemed<\/span> as<\/span> UNKNOWN<\/span> rather<\/span> than<\/span> FAILED<\/span><\/span><\/p>\n<\/li>\n

  • \n

    If<\/span> the<\/span> transaction<\/span> requires<\/span> 3D<\/span> Secure<\/span> validation,<\/span> then<\/span> the<\/span> CrossReference<\/span> will<\/span> be<\/span> used<\/span> as<\/span> the\u00a0<\/span><\/span>variable \u201cMD\u201d which needs to be posted to the Access Control Server (ACSURL) along with the PaREQ<\/p>\n<\/li>\n<\/ul>\n

      \n
    • \n

      If the External Data was requested in the CardDetailsTransaction message<\/span> (EchoExternalData=TRUE)<\/span> and<\/span> the<\/span> transaction<\/span> requires<\/span> 3D<\/span> Secure<\/span> validation,<\/span> the<\/span> External<\/span> Data<\/span> will<\/span> not be passed back in the<\/span> CardDetailsTransactionResponse. Such External Data will be returned in<\/span> the<\/span> ThreeDSecureAuthenticationResponse.<\/span><\/span><\/p>\n<\/li>\n

    • \n

      The<\/span> Amount<\/span> can<\/span> be<\/span> zero<\/span> (0)<\/span> if<\/span> the<\/span> TransactionType<\/span> is<\/span> passed<\/span> as<\/span> PREAUTH.<\/span><\/span><\/p>\n<\/li>\n

    • \n

      If<\/span> the<\/span> CardDetailsTransaction<\/span> message<\/span> contains<\/span> AlternatePaymentMethod<\/span> details,<\/span> Zero<\/span> (0)<\/span> Amount<\/span> is<\/span> not<\/span> allowed.<\/span><\/span><\/p>\n<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"

      Below are the details for the response that will be received after sending a CardDetailsTransaction request. Tag\/Attribute Name Data Type Max Length Always Present Comments CardDetailsTransactionResponse Yes CardDetailsTransactionResult Yes AuthorisationAttempted (attribute) B – Yes This indicates whether the transaction was actually sent to the acquirer for authorisation, or whether it failed before authorisation StatusCode N…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[2,70],"tags":[],"_links":{"self":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/512"}],"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=512"}],"version-history":[{"count":1,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/512\/revisions"}],"predecessor-version":[{"id":513,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/posts\/512\/revisions\/513"}],"wp:attachment":[{"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/media?parent=512"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/categories?post=512"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/payb.co.uk\/integration-guide\/wp-json\/wp\/v2\/tags?post=512"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}