Get by merchantTransactionId

GET 
/status/:apiKey/getByMerchantTransactionId/:merchantTransactionId

Retrieve status of the transaction identified by merchantTransactionId.

Rate limit

Please be aware of the rate limit for this API endpoint:

• Total limit: Each unique API user is limited to to 60 requests per 60-second window.
• Per merchantTransactionId limit: Each unique merchantTransactionId is limited to 10 request per 60-second window.

If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.

Request

Path Parameters

apiKey stringrequired

Possible values: <= 50 characters

API Key of Connector

merchantTransactionId stringrequired

Possible values: <= 50 characters

ID of merchant transaction

Responses

200

Status response

application/json

Schema

Schema

success stringrequired
Possible values: [true, false]
true
transactionStatus TransactionStatus
Possible values: [SUCCESS, PENDING, REDIRECT, CANCELLED, ERROR]
uuid string
merchantTransactionId string
Possible values: non-empty and <= 50 characters
purchaseId string
transactionType TransactionType
Possible values: [DEBIT, CAPTURE, DEREGISTER, PREAUTHORIZE, REFUND, REGISTER, VOID, CHARGEBACK, CHARGEBACK-REVERSAL, PAYOUT, INCREMENTAL-AUTHORIZATION]
paymentMethod string
amount string
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
currency string
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
surchargeAmount string
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
totalAmount string
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
schedules object[]
Array [
scheduleId string
ID of schedule which was started with the transaction.
scheduleStatus ScheduleStatus
Possible values: [ACTIVE, PAUSED, CANCELLED, ERROR, CREATE-PENDING, NON-EXISTING]
Status of the schedule.
scheduledAt date-time
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
merchantMetaData string
]
errors object[]
Array [
message stringrequired
code int32required
adapterMessage string
Adapter specific error message, passed verbatim from the upstream Adapter.
adapterCode string
Adapter specific error code, passed verbatim from the upstream Adapter.
]
chargebackData object
When transactionType is CHARGEBACK this field contains information on the chargeback.
originalUuid string
originalMerchantTransactionId string
Possible values: non-empty and <= 50 characters
amount string
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
currency string
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
reason string
chargebackDateTime date-time
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
property name* any
When transactionType is CHARGEBACK this field contains information on the chargeback.
chargebackReversalData object
When transactionType is CHARGEBACK-REVERSAL this field contains information on the chargeback-reversal.
originalUuid string
originalMerchantTransactionId string
Possible values: non-empty and <= 50 characters
chargebackUuid string
amount string
Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$
Decimal amount separated by ., maximum of 3 decimals.
currency string
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
reason string
reversalDateTime date-time
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
property name* any
When transactionType is CHARGEBACK-REVERSAL this field contains information on the chargeback-reversal.
extraData object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
Possible values: <= 64.
Property name: <= 64 characters.
Property value: <= 8192 characters.
property name* string
merchantMetaData string
returnData object
_TYPE stringrequired
Possible values: [cardData, phoneData, ibanData, walletData, achData]
cardData
type string
Type of credit card
firstName string
lastName string
country string
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
cardHolder string
expiryMonth string
Possible values: Value must match regular expression ^((0[1-9])|(1[0-2]))$
expiryYear string
Possible values: Value must match regular expression ^[0-9]{4}$
binDigits string
Possible values: Value must match regular expression ^[0-9]{6-8}$
firstSixDigits string
Possible values: Value must match regular expression ^[0-9]{6}$
lastFourDigits string
Possible values: Value must match regular expression ^[0-9]{4}$
fingerprint string
binBrand string
binBank string
binType string
binLevel string
binCountry string
threeDSecure ThreeDSecureType
Possible values: [OFF, OPTIONAL, MANDATORY]
Triggers the 3D Secure authentication for this transaction.
eci string
merchantAdviceCode string
Pipes through the merchant advice code for failed transactions if supported by the adapter.
parsedMerchantAdviceCode string
Possible values: [01, 02, 03]
Merchant advice code for failed transactions if supported by the adapter.
• 01 - Additional information needed.
• 02 - Try again later.
• 03 - Do not try again.
schemeTransactionIdentifier string
The schemeTransactionIdentifier, is a unique reference generated by a card scheme. It serves the purpose of traceability back to the initial transaction.
It is also referred to as the 'scheme reference ID,' 'scheme transaction ID,' 'trace ID' (for Mastercard), or 'transaction ID' (for VISA).
phoneData
phoneNumber string
country string
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
operator string
ibanData
accountOwner string
iban string
bic string
mandateId string
mandateDate date (string)
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date.
bankName string
bankBranchName string
country string
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
walletData
walletReferenceId string
Reference ID of the wallet.
walletOwner string
Owner of the wallet.
walletType string
Type of wallet.
walletOwnerFirstName string
First name of wallet owner.
walletOwnerLastName string
Last name of wallet owner.
walletOwnerCountryCode string
Country code of wallet owner.
walletRegistrationId string
UUID of the transaction that initially registered this wallet.
achData
accountHolder string
accountHolderType string
Possible values: [person, company]
accountType string
Possible values: [checking, savings]
accountNumber string
Possible values: <= 17 characters
routingNumber int32
Possible values: >= 9 characters and <= 9 characters
payByLinkData object
payByLink booleandeprecated
true if this transaction was a Pay-by-Link transaction.
sendViaEmail boolean
true if this Pay-by-Link was sent to the transaction customer via email.
cancelUrl uri
Endpoint to call to cancel a Pay-by-Link transaction.
For details, see Pay-by-Link API reference.
expiresAt date-time
Indicates at what date time the Pay-by-Link transaction expires.
property name* any
customer object
identification string
Possible values: <= 36 characters
firstName string
Possible values: <= 50 characters
lastName string
Possible values: <= 50 characters
birthDate date (string)
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date.
gender string
Possible values: [M, F]
billingAddress1 string
Possible values: <= 50 characters
billingAddress2 string
Possible values: <= 50 characters
billingCity string
Possible values: <= 50 characters
billingPostcode string
Possible values: <= 16 characters
billingState string
Possible values: <= 30 characters
billingCountry string
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
billingPhone string
Possible values: <= 20 characters
shippingFirstName string
Possible values: <= 50 characters
shippingLastName string
Possible values: <= 50 characters
shippingCompany string
Possible values: <= 50 characters
shippingAddress1 string
Possible values: <= 50 characters
shippingAddress2 string
Possible values: <= 50 characters
shippingCity string
Possible values: <= 50 characters
shippingPostcode string
Possible values: <= 16 characters
shippingState string
Possible values: <= 30 characters
shippingCountry string
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
shippingPhone string
Possible values: <= 20 characters
company string
Possible values: <= 50 characters
email string
Possible values: <= 255 characters
emailVerified boolean
ipAddress string
Possible values: <= 50 characters
nationalId string
Possible values: <= 20 characters
extraData object
Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.
Possible values: <= 64.
Property name: <= 64 characters.
Property value: <= 8192 characters.
property name* string
paymentData object
oneOf
PaymentIbanData
ibanData object
iban string
Possible values: <= 34 characters
bic string
Possible values: <= 11 characters
mandateId string
Possible values: <= 50 characters
mandateDate date (string)
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$
RFC 3339 Internet Date/Time Format full-date.
PaymentWalletData
walletData object
walletReferenceId string
Possible values: <= 255 characters
walletOwner string
Possible values: <= 255 characters
walletType string
Possible values: <= 255 characters
property name* any
customerProfileData object
profileGuid string
The unique customer profile identifier generated by the platform.
customerIdentification string
The customer profile identifier provided by you when creating the customer profile. Unique within one customer profile container.
paymentToken string
The created payment instrument for the customer profile, use with transactionToken when creating new transactions.
markAsPreferred boolean
Whether this payment instrument was marked as preferred for the customer.
property name* any
false
errorMessage string
Error message.
While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.
errorCode int32
adapterMessage string
adapterCode string
property name* any

Example (from schema)

{
  "success": true
}

Success

{
  "success": true,
  "transactionStatus": "SUCCESS",
  "uuid": "abcde12345abcde12345",
  "merchantTransactionId": "2019-09-02-0001",
  "purchaseId": "20190902-abcde12345abcde12345",
  "transactionType": "debit",
  "paymentMethod": "Creditcard",
  "amount": "9.99",
  "currency": "EUR",
  "customer": {
    "firstName": "Alex",
    "lastName": "Smith",
    "company": "Alex's Artisan Goods",
    "emailVerified": true
  },
  "extraData": {
    "someKey": "someValue",
    "otherKey": "otherValue"
  },
  "returnData": {
    "_TYPE": "cardData",
    "type": "visa",
    "cardHolder": "Alex Smith",
    "expiryMonth": 6,
    "expiryYear": 2026,
    "binDigits": "41111111",
    "firstSixDigits": "411111",
    "lastFourDigits": "1111",
    "threeDSecure": "OFF",
    "binBrand": "VISA",
    "binBank": "Global Trust Bank",
    "binCountry": "US"
  }
}

Error

{
  "success": false,
  "errorMessage": "Transaction not found",
  "errorCode": 8001
}

429

Rate limit exceeded

application/json

Schema

Schema

success boolean

Possible values: [false]

Returns true or false depending on whether the request was successful.

errorMessage string

Error message.

While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

errorCode int32
details stringnullable
property name* any

Example (from schema)

{
  "success": false,
  "errorMessage": "string",
  "errorCode": 0,
  "details": "string"
}

Example

{
  "success": false,
  "errorCode": 1009,
  "errorMessage": "Too many requests"
}

Loading...