Checking the status of a transaction

get https://api.sandbox.datatrans.com/v1/transactions/{transactionId}

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

Responses

Response body

object

transactionId

string

The transactionId received after an authorization.

merchantId

string

The merchant id.

type

string

payment credit card_check

status

string

The transaction status

Status	Description
initialized	When 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.
authenticated	When a transaction was authenticated. This status is only set if you defer the authorization from the authentication.
authorized	When a transaction was authorized. This status is only set if you defer the settlement from the authorization.
settled	When a transaction was settled partially or fully.
canceled	When a transaction was canceled by the user or automatically by the system after a time out occurred on our payment forms.
transmitted	When a transaction was transmitted to the acquirer for processing. This is automatically set by our system.
failed	When a transaction failed.

initialized challenge_required challenge_ongoing authenticated authorized settled canceled transmitted failed

currency

string

3 letter ISO-4217 character code. For example CHF or USD

refno

string

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

refno2

string

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

metadata

object

Merchant reference data

userData1

string

length between 0 and 40

Merchant description 1

userData2

string

length between 0 and 40

Merchant description 2

userData3

string

length between 0 and 40

Customer description 1

userData4

string

length between 0 and 40

Customer description 2

paymentMethod

string

ACC ALP APL AMX AZP BAC BON CBL CFY CSY CUP DEA DIN DII DIB DIS DNK 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

detail

object

Details about the various action steps of the transaction.

init

object

authorize

object

settle

object

credit

object

cancel

object

fail

object

customer

object

Customer details. Returned only if collected by the payment page. Setup dependent.

string

The email of the customer.

name

string

The full name of the customer.

firstName

string

The first name of the customer.

lastName

string

The last name of the customer.

street

string

The street of the customer.

city

string

The city of the customer.

country

string

2 letter ISO 3166-1 alpha-2 country code

zipCode

string

Zip code of the customer.

cdm

object

The response of the cybersource decision manager.

Has additional fields

accertify

object

Accertify decision (Accepted, Review, Declined

Has additional fields

language

string

length between 2 and 2

The language (language code) in which the payment was presented to the cardholder. The ISO-639-1 two letter language codes listed above are supported

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

card

object

If a credit card payment method was used for a transaction the card object holds all relevant properties for the used card.

alias

string

The resulting alias, if requested or available.

fingerprint

string

length between 24 and 24

An unique identifier of the card number. Useful to identify multiple customers' or the same customer's transactions where the same card was used.

masked

string

Masked credit card number. Can be used to display on a users profile page. For example: 424242xxxxxx4242

aliasCVV

string

Alias of the CVV. Will be deleted immediately after authorization.

expiryMonth

string

length between 2 and 2

The expiry month of the credit card alias.

expiryYear

string

length between 2 and 2

The expiry year of the credit card alias

info

object

The card information if the request was done with a card object

walletIndicator

string

APL PAY SAM VPS MBP

networkToken

object

Scheme token details. This information is only available if the card behind the alias has been tokenized.

altId

object

Scheme token details. This information is only available if the card behind the alias has been tokenized.

cardOnFile

object

Card On File (COF) parameters. COF usually is handled by Datatrans aliases. This feature is only for specific use cases where the Datatrans alias solution cannot be used.
This feature needs to be enabled on the merchant configuration by Datatrans.

object

3D authentication data, if available

TWI

object

If Twint was used for a transaction the object holds all Twint relevant properties.

alias

string

The Twint alias.

fingerprint

string

length between 24 and 24

An unique identifier of the card number. Useful to identify multiple customers' or the same customer's transactions where the same card was used.

PAP

object

If PayPal was used for a transaction the object holds all PayPal relevant properties.

orderId

string

The PayPal orderId, if the transaction was a PayPal order.

alias

string

The resulting alias, if requested or available.

payerId

string

The PayPal payerId

REK

object

If Reka was used for a transaction the object holds all Reka relevant properties.

alias

string

The resulting alias, if requested or available.

masked

string

Masked REKA number. Can be used to display on a users profile page.

expiryMonth

string

length between 2 and 2

The expiry month of the REKA card

expiryYear

string

length between 2 and 2

The expiry year of the REKA card

subtype

string

length between 3 and 3

The REKA payment subtype. REK for REKA Pay, REL for REKA Lunch, RER for REKA Rail.

REK REL RER

ELV

object

If ELV was used for a transaction the object holds all ELV relevant properties.

alias

string

The resulting alias, if requested or available.

mandateId

string

The mandate it which was passed in the init request if available.

iban

string

The used IBAN.

KLN

object

If KLN was used for a transaction the object holds all Klarna relevant properties.

alias

string

The resulting alias, if requested or available.

subtype

string

The Klarna payment subtype. For example 'invoice' or 'direct_bank_transfer' etc.

INT

object

If INT was used for a transaction the object holds all Byjuno relevant properties.

alias

string

The resulting alias, if requested or available.

SWP

object

If SWP was used for a transaction the object holds all SwissPass relevant properties.

alias

string

The resulting alias, if requested or available.

MPG

object

If MPG was used for a transaction the object holds all MPG relevant properties.

paycardNumber

string

the paycardNumber if available

qrData

object

QR code data if available

esr

object

Bank account details returned if invoiceOnDelivery was set in the init request.

MFG

object

If MFG was used for a transaction the object holds all MFG relevant properties.

esr

object

Bank account details returned if invoiceOnDelivery was set in the init request.

qrData

object

QR code data if available

MFX

object

If MFX was used for a transaction the object holds all MFX relevant properties.

alias

string

The resulting alias, if requested or available.

esr

object

Bank account details returned if invoiceOnDelivery was set in the init request.

qrData

object

QR code data if available

MPX

object

If MPX was used for a transaction the object holds all MPX relevant properties.

alias

string

The resulting alias, if requested or available.

paycardNumber

string

the paycardNumber if available

esr

object

Bank account details returned if invoiceOnDelivery was set in the init request.

qrData

object

QR code data if available

MDP

object

If MDP was used for a transaction the object holds all MDP relevant properties.

alias

string

The resulting alias, if requested or available.

ESY

object

If ESY was used for a transaction the object holds all Swisscom Pay relevant properties.

alias

string

The resulting alias, if requested or available.

PFC

object

If PFC was used for a transaction the object holds all Postfinance relevant properties.

alias

string

The resulting alias, if requested or available.

masked

string

Masked card number. Can be used to display on a users profile page. For example: ****2345

expiryMonth

string

length between 2 and 2

The expiry month of the Postfinance card

expiryYear

string

length between 2 and 2

The expiry year of the Postfinance card

PLU

object

If PLU was used for a transaction the object holds all SBBHalbtaxPlus relevant properties.

alias

string

The SBBHalbtaxPlus alias.

WEC

object

If WEC was used for a transaction the object holds all WeChat relevant properties.

prepayId

string

SCX

object

Supercard specific parameters.

subtype

string

length between 3 and 3

The SCX payment subtype. SCM for Mastercard, SCV for Visa and SCP for Visa prepaid

SCM SCV SCP

history

array of objects

history

object

action

string

The action performed.

init authenticate authorize settle credit cancel change_details

autoSettle

boolean

Indicates if auto settlement was used. Only applicable if action was authorize

requestId

string

Planet wide transaction Id per action.

amount

int64

The amount used.

source

string

From where the action originated.

admin amadeus ajax android api inline ios lightbox link redirect secure_fields system web web_hidden unknown

date

date-time

Date when the action was performed.

success

boolean

Whether the action was successful or not.

marketplace

object

If you are a marketplace merchant, use this object to send one or multiplesplits per transaction.

string

The IP address from where the action originated from.

ep2

object

EP2 data if available.

trmID

string

The terminal ID

trxSeqCnt

string

The transaction Sequence Count

aid

string

The application Identifier

amtAuth

string

The authorized amount

trxDate

string

The date of the processing

trxTime

string

The time of the processing

pan

string

The PAN

appPanEnc

string

The encrypted cardholder account number

issuerCode

string

The issuer code

actSeqCnt

int32

The activation sequence count

trxRefNum

string

The transaction reference number

trxTypeExt

string

The transaction type extension

brand

string

The brand

authCode

string

The authorization code

staticKeyIndex

string

The static key index

trxCurrC

string

The transaction currency code

dcc

object

DCC (Dynamic Currency Conversion) data if available.

currency

string

The DCC currency

amount

int64

The DCC amount

rate

double

The DCC rate

markup

double

The DCC markup

multiCurrencyProcessing

object

Multi currency processing data if sent during init or authorization

currency

string

The targeted currency

conversionRate

double

required

Conversion rate received from the currency rates endpoint

amount

int64

The amount in your targeted currency

transactionDate

date-time

required

Transaction datetime received from the currency rates endpoint

localTransactionTime

string

required

LocalTransactionTime received from the currency rates endpoint

retrievalReferenceNumber

string

required

RetrievalReferenceNumber received from the currency rates endpoint

userId

string

required

provider

string

required

The provider for multi currency processing

reasonIndicator

string

required

If received from acquirer the reason indicator can be set

avs

object

Address Verification Service Response properties.

result

string

required

The result of the address verification. It is the exact same resultas returned from the acquirer. Be aware that different acquirers can returnresult codes.

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sandbox.datatrans.com/v1/transactions/transactionId \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Status of a transaction

400Invalid request