/v1/transactions

Checking the status of a transaction

Changed on

The API endpoint status can be used to check the status of any transaction, see its history, and retrieve the card information.

get/v1/transactions/{transactionId}

Request

  • Base URL
    https://api.sandbox.datatrans.com
  • URL
    https://api.sandbox.datatrans.com/v1/transactions/{transactionId}
  • Auth
    HTTP basic

Path parameters

transactionIdinteger required

The transactionId received after an authorization.

Response

Status of a transaction

transactionIdstring

The transactionId received after an authorization.

merchantIdstring

The merchant id.

type'payment' | 'credit' | 'card_check'
status'initialized' | 'challenge_required' | 'challenge_ongoing' | 'authenticated' | 'authorized' | 'settled' | 'canceled' | 'transmitted' | 'failed'

The transaction status

StatusDescription
initializedWhen a transaction was initialized. A transaction is initialized after a successful init request. This status is only set for customer-initiated flows before consumers start their payment via our payment forms.
authenticatedWhen a transaction was authenticated. This status is only set if you defer the authorization from the authentication.
authorizedWhen a transaction was authorized. This status is only set if you defer the settlement from the authorization.
settledWhen a transaction was settled partially or fully.
canceledWhen a transaction was canceled by the user or automatically by the system after a time out occurred on our payment forms.
transmittedWhen a transaction was transmitted to the acquirer for processing. This is automatically set by our system.
failedWhen a transaction failed.
currencystring

3 letter <a href='https://en.wikipedia.org/wiki/ISO_4217' target='_blank'>ISO-4217</a> character code. For example CHF or USD

refnostring

The merchant's reference number. It should be unique for each transaction.

refno2string

Optional customer's reference number. Supported by some payment methods or acquirers.

paymentMethod'ACC' | 'ALP' | 'APL' | 'AMX' | 'AZP' | 'BAC' | 'BON' | 'CBL' | 'CFY' | 'CSY' | 'CUP' | 'DEA' | 'DIN' | 'DII' | 'DIB' | 'DIS' | 'DNK' | 'DMO' | 'ECA' | 'ELV' | 'EPS' | 'ESY' | 'GFT' | 'GPA' | 'HPC' | 'INT' | 'JCB' | 'JEL' | 'KLN' | 'MAU' | 'MDP' | 'MFA' | 'MFX' | 'MPA' | 'MFG' | 'MPG' | 'MPX' | 'MYO' | 'PAP' | 'PAY' | 'PEF' | 'PFC' | 'PSC' | 'REK' | 'SAM' | 'SWB' | 'SCX' | 'SWP' | 'TWI' | 'UAP' | 'VIS' | 'WEC' | 'SWH' | 'VPS' | 'MBP' | 'CUV' | 'GEP' | 'PLU' | 'DVI' | 'PFP' | 'PYL'
cdmCDMResponse

The response of the cybersource decision manager.

accertifyAccertify

Accertify decision (Accepted, Review, Declined

language'en' | 'de' | 'fr' | 'it' | 'es' | 'el' | 'fi' | 'hu' | 'ko' | 'nl' | 'no' | 'da' | 'pl' | 'pt' | 'ru' | 'ja' | 'sk' | 'sl' | 'sv' | 'tr' | 'zh'

The language (language code) in which the payment was presented to the cardholder. The <a href='https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes' target='_blank'>ISO-639-1</a> two letter language codes listed above are supported

Example response

{
  "card": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt",
    "fingerprint": "F-coGuJQ55tUk8CnKGI9PX1T",
    "networkToken": {
      "paymentAccountReference": "5001a9f027e5629d11e3949a0800a"
    }
  },
  "TWI": {
    "fingerprint": "F-coGuJQ55tUk8CnKGI9PX1T"
  },
  "PAP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "REK": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "ELV": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "KLN": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "INT": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "SWP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MFX": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MPX": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "MDP": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "ESY": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PFC": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  },
  "PFP": {
    "fingerprint": "F-coGuJQ55tUk8CnKGI9PX1T"
  },
  "DMO": {
    "alias": "AAABeCBPbiHssdexyrAAAYkaznYWAPYt"
  }
}

Changes

    • warning

      added the new C2P enum value to the / response property for the response status

    • warning

      added the new CONCURRENT_LIMIT_REACHED enum value to the / response property for the response status

    • warning

      added the new DMO enum value to the response property for the response status

    • warning

      added the new NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ROUTING_LOOKUP_FAILED enum value to the / response property for the response status

    • warning

      added the new ROUTING_NOT_CONFIGURED enum value to the / response property for the response status

    • warning

      added the new ROUTING_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new card_blocked enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status