commonResponse

The commonResponse object allows to obtain general information about an operation.

Table 1. commonResponse object
commonResponse Format
responseCode

See chapter Managing application errors.

First attribute to be analyzed regardless of the operation.

  • The value 0 indicates that the operation is successfully completed (should not be confused with transaction status)
  • A value different from 0 involves an analysis of the responseCodeDetails attribute. It specifies the origin of the error.
n..2
responseCodeDetail

Information about the error if the responseCode attribute is not 0.

For more information, see chapter Managing application errors.

string
transactionStatusLabel

Name of the transaction status. The possible values are:

  • INITIAL

    Treatment in progress.

    This status is temporary. The final status will be returned once the synchronization is processed.
  • NOT_CREATED

    The transaction has not been created and can not be viewed in the Merchant Back Office.

  • AUTHORISED

    Waiting for capture.

    The transaction has been accepted and will be automatically captured by the bank on the due date.
  • AUTHORISED_TO_VALIDATE

    To be validated.

    The transaction, created with manual validation, is authorized. The merchant must manually validate the capture in the bank. The transaction can be validated as long as the capture date has not passed. If the capture date has passed, the payment status changes to Expired (unless definitive).
  • WAITING_AUTHORISATION

    Waiting for authorization.

    The requested capture date exceeds the authorization request expiration date.
    An authorization of 1 EUR100 XPF1 CHF1 BRL100 CLP1 USD1000 XOF100 INR (or information request about the CB network if the acquirer supports it) has been made and accepted by the issuing bank. The authorization request and the capture will be triggered automatically.
  • WAITING_AUTHORISATION_TO_VALIDATE

    To be validated and authorized.

    The requested capture date exceeds the authorization request expiration date.
    An authorization of 1 EUR100 XPF1 CHF1 BRL100 CLP1 USD1000 XOF100 INR (or information request about the CB network if the acquirer supports it)has been made and accepted by the issuing bank. An authorization request for the total amount will be automatically processed 1 day before the capture date. The payment might be accepted or declined. The capture is automatic.
  • REFUSED

    Declined.

    The transaction has been declined.
string
shopId

Shop ID

n8
paymentSource

Transaction source. The possible values are:

  • EC for e-commerce.
  • MOTO for a MOTO order.
  • CC for a call center.
  • OTHER for another sales channel.
string (enum)
submissionDate

Transaction date and UTC time in W3C format (e.g.: 2016-07-16T19:20:00Z).

dateTime ans..40
contractNumber

Number of the merchant acceptance agreement.

string
paymentToken

Token.

string