Direct Support Site

Results for

icon-search-large No search results yet
Enter your search query above

1. Introduction

Our platform returns for many of the API calls the status of your request. This covers both requests for creating a new transaction or for getting the current status of an already existing transaction.
In most cases, our platform returns an object containing three (nested) properties describing all possible scenarios in a human-readable form:

Property Description
status The current high-level status of the payment
statusCategory Detailed information about the high-level status, containing instructions and/or possible reasons explaining the current high-level status
statusCode Numeric representation of the transaction status 

Check out the following chapter to learn more about these return values and what they mean.

2. Understand human-readable return values

To be on top of your transactions, it is important to understand the exact meaning of these human-readable return values. Depending on the respective API call and the transaction status, they tell you everything you need to know about the transaction’s status, errors and possible follow-up actions.

Property "status"

The following values apply for these API calls, webhooks and properties

Possible values Description
CREATED The transaction has been created and is still in a pending status. This is the initial status for any new transaction request on our platform.
CANCELLED The transaction/authorisation has been cancelled by either your customer or yourself
REJECTED The authorisation/refund request has been rejected by the acquirer
REJECTED_CAPTURE The capture request has been rejected by the acquirer
REDIRECTED You have redirected your customer
  • to her/his issuer for a 3-D Secure check (applicable for Hosted Tokenization Page or Server-to-server integration mode) or we have not received the 3-D Secure check result yet
  • to the payment portal of a third party or we have not received a transaction result from this third party yet
PENDING_CAPTURE Your authorisation request was successful, but you still need to capture it to receive the funds
AUTHORIZATION_REQUESTED Our platform is processing your authorisation request and waiting for the result. As soon as we have received the result, we will update the status to either “REJECTED” or “PENDING_CAPTURE” accordingly
CAPTURE_REQUESTED Our platform is processing your capture request and waiting for the result. As soon as we have received the result, we will update the status to either “REJECTED_CAPTURE” or “CAPTURED” accordingly
CAPTURED Your capture request (“CAPTURE_REQUESTED”) has been successful. You can expect to receive the funds for this transaction from your acquirer
REFUND_REQUESTED Our platform is processing your refund request and waiting for the result. As soon as we have received the result, we will update the status to either “REJECTED” or “REFUNDED” accordingly
REFUNDED

Your refund request (“REFUND_REQUESTED”) has been successful. You customer can expect to receive the funds for this transaction from her/his issuers

Mind that for API call GetHostedCheckoutStatus different values apply for this property. Check them out in the dedicated chapter

Property "statusOutput.statusCategory"

The following values apply for these API calls, webhooks and properties

Possible values Description
CREATED The transaction has been created and is still in a pending status. This is the initial status for any new transaction request on our platform.
UNSUCCESSFUL Your authorisation/capture/refund request has been unsuccessful
PENDING_PAYMENT You are waiting for either
  • the final result of a transaction in status="CREATED"
  • the result of a 3-D Secure check of a transaction in status="REDIRECTED"
PENDING_MERCHANT This transaction is a pending status because either
  • You still need to capture it due to its status="PENDING_CAPTURE"
  • You are waiting for a final result for transactions in status="CANCELLED"
PENDING_CONNECT_OR_3RD_PARTY We are waiting for a final result for your authorisation/capture/refund request
REFUNDED Your refund request has been successful
COMPLETED Your direct sale request has been successful
Mind that for API call GetHostedCheckoutStatus different values apply for this property. Check them out in the dedicated chapter

Property "statusOutput.statusCode"

The following values apply for these API calls, webhooks and properties.
Check out our dedicated chapter about the meaning of the numeric status for these API calls and properties:

Property “status” (GetHostedCheckoutStatus)

The following values apply for exclusively for API call/property “status” (GetHostedCheckoutStatus):

Possible values Description
PAYMENT_CREATED The transaction has been created and is still in a pending status. This is the initial status for any new transaction request on our platform.
IN_PROGRESS Your customer has not finalised
  • the purchase on the Hosted Checkout Page or the third party payment provider’s portal (i.e. PayPal) yet
  • the 3-D Secure check at her/his issuer's site yet
CANCELLED_BY_CONSUMER Your customer has cancelled the purchase on the Hosted Checkout Page by clicking on the "Cancel" button

Property "createdPaymentOutput.paymentStatusCategory" (GetHostedCheckoutStatus)

The following values apply for exclusively for API call/property “status” (GetHostedCheckoutStatus):

Possible values Description
SUCCESSFUL Your customer has finalised the purchase on the Hosted Checkout Page or the third party payment provider’s portal (i.e. PayPal)
REJECTED Your customer has finalised the purchase on the Hosted Checkout Page or the third party payment provider’s portal (i.e. PayPal), resulting in an unsuccessful authorisation/capture
STATUS_UNKNOWN Your customer has not finalised
  • the purchase on the Hosted Checkout Page or the third party payment provider’s portal (i.e. PayPal) yet
  • the 3-D Secure check at her/his issuer's site yet

3. Understand possible outcomes

Every API call providing feedback has a specific range of possible values. Have a look at the possible property value combinations per API call:

GetPayment/CreatePayment

status / payment.status payment.statusOutput / statusOutput
statusCategory statusCode
CREATED CREATED  0
CANCELLED UNSUCCESSFUL 1/6/61/62/64/75/96
REJECTED UNSUCCESSFUL 2/57/59/73/83
REJECTED_CAPTURE UNSUCCESSFUL 93
REDIRECTED PENDING_CONNECT_OR_3RD_PARTY 46
PENDING_CAPTURE PENDING_MERCHANT 5/56
AUTHORIZATION_REQUESTED PENDING_CONNECT_OR_3RD_PARTY 50/51/55
CAPTURED COMPLETED 9

GetHostedCheckoutStatus

status createdPayment
Output.
paymentStatusCategory

createdPaymentOutput.
payment.status

createdPaymentOutput.payment.
statusOutput

statusCategory statusCode
PAYMENT_CREATED REJECTED CREATED CREATED 0
CANCELLED UNSUCCESSFUL 1/6/61/62/64/75
REJECTED 2/57/59/73/83
REJECTED_CAPTURE 93
STATUS_UNKNOWN REDIRECTED PENDING_
PAYMENT
0/46
SUCCESSFUL PENDING_CAPTURE PENDING_
MERCHANT
5/56

AUTHORIZATION_
REQUESTED

PENDING_
CONNECT_OR_
3RD_PARTY
50/51/55
CAPTURE_REQUESTED

4/91/92/99
CAPTURED COMPLETED 9
REFUND_REQUESTED REVERSED 81/82
REFUNDED 7/8/85
IN_PROGRESS N/A N/A N/A 0
CANCELLED_BY_CONSUMER N/A N/A N/A 1

RefundPayment/GetRefunds

status statusOutput

statusCategory statusCode
REJECTED UNSUCCESSFUL 73/83
REFUND_REQUESTED PENDING_CONNECT_OR_3RD_PARTY 71/72/81/82
REFUNDED REFUNDED 7/8/85

CapturePayment/GetCapture

status statusOutput.statusCode

REJECTED_CAPTURE 93
CAPTURE_REQUESTED 4/91/92/99

CancelPayment

payment.status payment.statusOutput
statusCategory statusCode
CANCELLED PENDING_MERCHANT 61/62
CANCELLED UNSUCCESSFUL 6

4. Understand numeric status codes

In contrast to statusCategory and status, property statusCode return an integer instead of a string. In conjunction with the string-based properties, statusCode gives you the full picture of the transaction’s status and thereby the right API call to use in any given scenario.