Server API version 1.0
Java

Results for

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

Get hosted checkout status

GET https://{domainname}/v1/{merchantId}/hostedcheckouts/{hostedCheckoutId}

Hosted Checkouts

Using hostedCheckouts you can process transactions using MyCheckout, our easy to use hosted responsive payment pages. Your consumers will be able to complete the payment process using MyCheckout that is hosted by us. Using these pages to capture card details and process card transactions will greatly reduce not only your integration efforts, but it will also reduce your 'PCI exposure' to the lowest level (SAQ-A).

The layout and look and feel of the MyCheckout Pages can be managed through the Configuration Center. Here you will find the powerful, yet very intuitive MyCheckout editor that lets you create multiple variations of your hosted payment pages hosted by us. If you have created multiple versions you are able to direct your consumers to specific variants through this API. This allows you easily test out different variations or continue specific campaigns all the way through to the payment pages.

The MyCheckout pages automatically adapt based on screen width of your consumers device. Clients that do not support JavaScript to be run on the client will still be able to make payments (although they will lack all the client side validation and automatic formatting to assist them). Please note that both the responsive nature and the support for clients without JavaScript support might not apply to 3rd party payment pages that the consumer might be redirected to to complete the payment.

MyCheckout is also modular in its setup, allowing you to specify exactly what you want us to do as part of your checkout flow. You decide if we should display the payment product selection and/or the confirmation page after a successful payment.

In case a payment product that requires the consumer to (manually) push the funds was selected, you will have the option to show these instructions again at a later moment. You could show them on your website in an area where the consumer can track the progress of their order. To avoid multiple payments you should however avoid showing them again for transactions that have already been paid.

Request

You can retrieve the current status of the hosted checkout by doing a get on the hostedCheckoutId. When a payment has been created during the hosted checkout session the details are returned in this object.

Sessions have a maximum life span of 2 hours. This means that you can only retrieve this information while the session has not timed-out.
The status of the hostedCheckout and the payment will change when the consumer is still busy completing the hosted checkout session.
The request does not have any additional input parameters.

Request example

SDK: Java

This scenario you will probably use the most

  • GetHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().get("hostedCheckoutId");
    

Responses

In case the hostedCheckoutId has not yet expired the response to the GET request will contain the status of the hosted checkout. In case the consumer has also made a payment during the session a createdPaymentOutput object is returned containing the details of the created payment object. Please note that for payments that involve a redirect to a 3rd party, like iDeal or PayPal, the payment might not have been completed at the moment you retrieved the status. This is indicated by the status contained in the createdPaymentOutput object.

Response 200 - OKGetHostedCheckoutResponse

The request was processed correctly and a valid response is returned. In case a payment was created during the hosted checkout the details are returned in the createdPaymentOutput object.

         Property Type Required Description
object no SDK object type: CreatedPaymentOutput
When a payment has been created during the hosted checkout session this object will return the details.
object no SDK object type: DisplayedData
Object that contains the action, including the needed data, that you should perform next, like showing instruction, showing the transaction results or redirect to a third party to complete the payment
displayedDataType enum no

Action merchants needs to take in the online payment process. Possible values are:
  • SHOW_INSTRUCTIONS - The consumer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData
  • SHOW_TRANSACTION_RESULTS - The consumer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the renderingData

renderingData string no

This field contains the blob with data for the instructions rendering service.

This service will be available at the following endpoint: http(s)://{{merchant specific subdomain}}.{{base MyCheckout hosted payment pages domain}}/instructions/{{merchantId}}/{{clientSessionId}}

This instructions page rendering service accepts the following parameters:

  • renderingData (required, the content of this field)
  • locale (optional, if present overrides default locale, e.g. "en_GB")
  • variant (optional, code of a variant, if present overrides default variant, e.g. "100")
You can offer a link to a consumer to see an instructions page for a payment done earlier. Because of the size of the renderingData this will need to be set in a web form as a value of a hidden field. Before presenting the link you need to obtain a clientSessionId by creating a session using the S2S API. You will need to use the MyCheckout hosted payment pages domain hosted in the same region as the API domain used for the createClientSession call.

The renderingData is a String blob that is presented to you via the Server API as part of the merchantAction (if available, and non-redirect) in the JSON return values for the createPayment call or the getHostedCheckoutStatus call (merchantAction inside createdPaymentOutput when available). You are responsible to store the renderingData blob in order to be able to present the instructions page at a later time, when this information might no longer be available through Server API calls.

array no
Array of key value pairs of data that needs to be shown to the consumer. This is returned for both the SHOW_INSTRUCTION as well as the SHOW_TRANSACTION_RESULTS actionType.
Note: The returned value for the key BARCODE is a base64 encoded gif image. By prepending 'data:image/gif;base64,' this value can be used as the source of an HTML inline image.
object no SDK object type: KeyValuePair
key string no

Name of the key or field

value string no

Value of the key or field

object no SDK object type: Payment
Object that holds the payment data
object no SDK object type: HostedCheckoutSpecificOutput
Hosted Checkout specific information. Populated if the payment was created on the GlobalCollect platform through a Hosted Checkout.
hostedCheckoutId string no

The ID of the Hosted Checkout Session in which the payment was made.

variant string no

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your hosted mandate pages in a controlled manner. Please note that you need to specify the ID of the variant.

id string no

Our unique payment transaction identifier.

object no SDK object type: PaymentOutput
Object containing payment details
object no SDK object type: AmountOfMoney
Object containing amount and ISO currency code attributes
amount integer (12) yes

Amount in cents and always having 2 decimals

currencyCode string (3) yes

Three-letter ISO currency code representing the currency for the amount

amountPaid integer no

Amount that has been paid

object yes,

one of group

SDK object type: BankTransferPaymentMethodSpecificOutput
Object containing the bank transfer payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: CardPaymentMethodSpecificOutput
Object containing the card payment method details
authorisationCode string no

Card Authorization code as returned by the acquirer

object no SDK object type: CardEssentials
Object containing card details
cardNumber string (19) no

The complete credit/debit card number

expiryDate string (4) no

Expiry date of the card
Format: MMYY

object no SDK object type: CardFraudResults
Fraud results contained in the CardFraudResults object
avsResult string no

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available

cvvResult string no

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available

fraudServiceResult string no

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.

object no SDK object type: FraudResultsRetailDecisions
Additional response data returned by RetailDecisions
fraudCode string no

Result of the fraud service. Provides additional information about the fraud result

fraudNeural string no

Returns the raw score of the neural

fraudRCF string no

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object no SDK object type: ThreeDSecureResults
3D Secure results object
cavv string no

CAVV or AVV result indicating authentication validation value

eci string no

Indicates Authentication validation results returned after AuthenticationValidation

xid string no

Transaction ID for the Authentication

token string no

ID of the token. This property is populated for the Ogone payment platform when the payment was done with a token or when the payment was tokenized.

object yes,

one of group

SDK object type: CashPaymentMethodSpecificOutput
Object containing the cash payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: NonSepaDirectDebitPaymentMethodSpecificOutput
Object containing the non SEPA direct debit payment method details
object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: EInvoicePaymentMethodSpecificOutput
Object containing the e-invoice payment method details
object no SDK object type: EInvoicePaymentProduct9000SpecificOutput
AfterPay Installments (payment product 9000) specific details
installmentId string yes

The ID of the installment plan used for the payment.

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: InvoicePaymentMethodSpecificOutput
Object containing the invoice payment method details
paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object yes,

one of group

SDK object type: MobilePaymentMethodSpecificOutput
Object containing the mobile payment method details
authorisationCode string no

Card Authorization code as returned by the acquirer

object no SDK object type: CardFraudResults
Fraud results contained in the CardFraudResults object
avsResult string no

Result of the Address Verification Service checks. Possible values are:
  • A - Address (Street) matches, Zip does not
  • B - Street address match for international transactions—Postal code not verified due to incompatible formats
  • C - Street address and postal code not verified for international transaction due to incompatible formats
  • D - Street address and postal code match for international transaction, cardholder name is incorrect
  • E - AVS error
  • F - Address does match and five digit ZIP code does match (UK only)
  • G - Address information is unavailable; international transaction; non-AVS participant
  • H - Billing address and postal code match, cardholder name is incorrect (Amex)
  • I - Address information not verified for international transaction
  • K - Cardholder name matches (Amex)
  • L - Cardholder name and postal code match (Amex)
  • M - Cardholder name, street address, and postal code match for international transaction
  • N - No Match on Address (Street) or Zip
  • O - Cardholder name and address match (Amex)
  • P - Postal codes match for international transaction—Street address not verified due to incompatible formats
  • Q - Billing address matches, cardholder is incorrect (Amex)
  • R - Retry, System unavailable or Timed out
  • S - Service not supported by issuer
  • U - Address information is unavailable
  • W - 9 digit Zip matches, Address (Street) does not
  • X - Exact AVS Match
  • Y - Address (Street) and 5 digit Zip match
  • Z - 5 digit Zip matches, Address (Street) does not
  • 0 - No service available

cvvResult string no

Result of the Card Verification Value checks. Possible values are:
  • M - CVV check performed and valid value
  • N - CVV checked and no match
  • P - CVV check not performed, not requested
  • S - Cardholder claims no CVV code on card, issuer states CVV-code should be on card
  • U - Issuer not certified for CVV2
  • Y - Server provider did not respond
  • 0 - No service available

fraudServiceResult string no

Resulting advice of the fraud prevention checks. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted an error. Note that the fraud check was thus not performed.

object no SDK object type: FraudResultsRetailDecisions
Additional response data returned by RetailDecisions
fraudCode string no

Result of the fraud service. Provides additional information about the fraud result

fraudNeural string no

Returns the raw score of the neural

fraudRCF string no

Result of the fraud service Represent sets of fraud rules returned during the evaluation of the transaction

network string no

The network that was used for the refund

object no SDK object type: MobilePaymentData
Object containing payment details
dpan string (19) yes

The obfuscated DPAN. Only the last four digits are visible.

expiryDate string (4) yes

Expiry date of the tokenized card
Format: MMYY

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

object no SDK object type: ThreeDSecureResults
3D Secure results object
cavv string no

CAVV or AVV result indicating authentication validation value

eci string no

Indicates Authentication validation results returned after AuthenticationValidation

xid string no

Transaction ID for the Authentication

object yes,

one of group

SDK object type: RedirectPaymentMethodSpecificOutput
Object containing the redirect payment product details
object no SDK object type: BankAccountIban
Object containing account holder name and IBAN information
accountHolderName string (30) depends

Name in which the account is held.
Depends on: Required for the creation of a Payout
Required for Create and Update token calls.

iban string (50) depends

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
Depends on: Required for the creation of a Payout
Required for Create and Update token.
Required for payments with product 9000 in Austria (AT) and Germany (DE).
Required for Create mandate and Create payment with mandate calls

object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

object no,

one of group

SDK object type: PaymentProduct836SpecificOutput
Sofort (payment product 836) specific details
securityIndicator string no

Indicates if SofortBank could estabilish if the transaction could successfully be processed.
  • 0 - You should wait for the transaction to be reported as paid before shipping any goods.
  • 1 - You can ship the goods. In case the transaction is not reported as paid you can initiate a claims process with SofortBank.

object no,

one of group

SDK object type: PaymentProduct840SpecificOutput
PayPal (payment product 840) specific details
object no SDK object type: PaymentProduct840CustomerAccount
Object containing the details of the PayPal account
accountId string no

Username with which the PayPal account holder has registered at PayPal

billingAgreementId string no

Identification of the PayPal recurring billing agreement

companyName string no

Name of the company in case the PayPal account is owned by a business

countryCode string no

Country where the PayPal account is located

customerAccountStatus string no

Status of the PayPal account.
Possible values are:
  • verified - PayPal has verified the funding means for this account
  • unverified - PayPal has not verified the funding means for this account

customerAddressStatus string no

Status of the consumer's shipping address as registered by PayPal
Possible values are:
  • none - Status is unknown at PayPal
  • confirmed - The address has been confirmed
  • unconfirmed - The address has not been confirmed

firstName string no

First name of the PayPal account holder

payerId string no

The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account

surname string no

Surname of the PayPal account holder

object no SDK object type: Address
Object containing the address details of the consumer
additionalInfo string (50) no

Additional address information

city string (40) depends

City
Depends on: Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.

countryCode string (2) depends

ISO 3166-1 alpha-2 country code
Depends on: Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.

houseNumber string (15) depends

House number
Depends on: Required when address is included in Seller.

state string (35) no

Full name of the state or province

stateCode string (9) no

State code

street string (50) depends

Streetname
Depends on: Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.

zip string (10) depends

Zip code
Depends on: Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.

object no SDK object type: ProtectionEligibility
Protection Eligibility data of the PayPal customer
eligibility string no

Possible values:
  • Eligible
  • PartiallyEligible
  • Ineligible

type string no

Possible values:
  • ItemNotReceivedEligible
  • UnauthorizedPaymentEligible
  • Ineligible

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

token string no

ID of the token. This property is populated for the Ogone payment platform when the payment was done with a token or when the payment was tokenized.

object yes,

one of group

SDK object type: SepaDirectDebitPaymentMethodSpecificOutput
Object containing the SEPA direct debit details
object no SDK object type: FraudResults
Object containing the results of the fraud screening
fraudServiceResult string no

Results from the fraud prevention check. Possible values are:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed

object no SDK object type: PaymentProduct771SpecificOutput
Output that is SEPA Direct Debit specific (i.e. the used mandate)
mandateReference string no

Unique reference to a Mandate

paymentProductId integer no

Payment product identifier
Please see payment products for a full overview of possible values.

paymentMethod string no

Payment method identifier used by the our payment engine with the following possible values:
  • bankRefund
  • bankTransfer
  • card
  • cash
  • directDebit
  • eInvoice
  • invoice
  • redirect

object no SDK object type: PaymentReferences
Object that holds all reference fields that are linked to this transaction
merchantOrderId integer no

Your order ID for this transaction that is also returned in our report files

merchantReference string no

Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files.

paymentReference string no

Payment Reference generated by WebCollect

providerId string no

Provides an additional means of reconciliation for Gateway merchants

providerReference string no

Provides an additional means of reconciliation for Gateway merchants

referenceOrigPayment string no

When you did not supply a merchantReference for your payment, you need to fill this field with the reference of the original payment when you want to refund it

status enum no

Current high-level status of the payment in a human-readable form. Possible values are :
  • ACCOUNT_VERIFIED - The account has been verified using a validation services like 0$ auth
  • CREATED - The transaction has been created. This is the initial state once a new payment is created.
  • REDIRECTED - The consumer has been redirected to a 3rd party to complete the authentication/payment
  • PENDING_PAYMENT - Instructions have been provided and we are now waiting for the money to come in
  • PENDING_FRAUD_APPROVAL - The transaction has been marked for manual review after an automatic fraud screening
  • PENDING_APPROVAL - The transaction is awaiting approval from you to proceed with the capturing of the funds
  • PENDING_COMPLETION - The transaction needs to be completed.
  • PENDING_CAPTURE - The transaction is waiting for you to request one or more captures of the funds.
  • REJECTED - The transaction has been rejected
  • AUTHORIZATION_REQUESTED - we have requested an authorization against an asynchronous system and is awaiting its response
  • CAPTURE_REQUESTED - The transaction is in the queue to be captured
  • CAPTURED - The transaction has been captured and we have received online confirmation
  • PAID - We have matched the incoming funds to the transaction
  • CANCELLED - You have cancelled the transaction
  • REJECTED_CAPTURE - We or one of our downstream acquirers/providers have rejected the capture request
  • REVERSED - The transaction has been reversed
  • CHARGEBACK_NOTIFICATION - We have received a notification of chargeback and this status informs you that your account will be debited for a particular transaction
  • CHARGEBACKED - The transaction has been chargebacked
  • REFUNDED - The transaction has been refunded

Please see Statuses for a full overview of possible values.

object no SDK object type: PaymentStatusOutput
This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.
array no
Custom object contains the set of errors
object no SDK object type: APIError
category string no

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

code string yes

Error code

httpStatusCode integer no

HTTP status code for this error that can be used to determine the type of error

id string no

ID of the error. This is a short human-readable message that briefly describes the error.

message string no

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud

propertyName string no

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

requestId string no

ID of the request that can be used for debugging purposes

isAuthorized boolean no

Indicates if the transaction has been authorized
  • true
  • false

isCancellable boolean no

Flag indicating if the payment can be cancelled
  • true
  • false

isRefundable boolean no

Flag indicating if the payment can be refunded
  • true
  • false

statusCategory enum no

Highlevel status of the payment, payout or refund with the following possible values:
  • CREATED - The transaction has been created. This is the initial state once a new payment, payout or refund is created. This category groups the following statuses:
    • CREATED
  • PENDING_PAYMENT: The payment is waiting on consumer action. This category groups the following statuses:
    • PENDING_PAYMENT
    • REDIRECTED
  • ACCOUNT_VERIFIED: The account has been verified. This category groups the following statuses:
    • ACCOUNT_VERIFIED
  • PENDING_MERCHANT: The transaction is awaiting approval to proceed with the payment, payout or refund. This category groups the following statuses:
    • PENDING_APPROVAL
    • PENDING_COMPLETION
    • PENDING_CAPTURE
    • PENDING_FRAUD_APPROVAL
  • PENDING_CONNECT_OR_3RD_PARTY: The transaction is in the queue to be processed. This category groups the following statuses:
    • AUTHORIZATION_REQUESTED
    • CAPTURE_REQUESTED
    • PAYOUT_REQUESTED
    • REFUND_REQUESTED
  • COMPLETED: The transaction has completed. This category groups the following statuses:
    • CAPTURED
    • PAID
    • ACCOUNT_CREDITED
    • CHARGEBACK_NOTIFICATION
  • REVERSED: The transaction has been reversed. This category groups the following statuses:
    • CHARGEBACKED
    • REVERSED
  • REFUNDED: The transaction has been refunded. This category groups the following statuses:
    • REFUNDED
  • UNSUCCESSFUL: The transaction has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CANCELLED
    • REJECTED
    • REJECTED_CAPTURE
    • REJECTED_CREDIT

Please see Statuses for a full overview of possible values.

statusCode integer no

Numeric status code that is returned by either Ingenico's Global Collect Payment Platform or Ingenico's Ogone Payment Platform. It is returned to ease the migration from the local APIs to Ingenico Connect. You should not write new business logic based on this field as it will be deprecated in a future version of the API. The value can also be found in the Global Collect Payment Console, in the Global Collect report files and the Ogone BackOffice and report files.

statusCodeChangeDateTime string no

Date and time of payment
Format: YYYYMMDDHH24MISS

object no SDK object type: PaymentCreationReferences
Object containing the created references
additionalReference string no

The additional reference identifier for this transaction. Data in this field will also be returned in our report files, allowing you to reconcile them.

externalReference string no

The external reference identifier for this transaction. Data in this field will also be returned in our report files, allowing you to reconcile them.

paymentStatusCategory enum no

Highlevel indication of the payment status with the following possible values:
  • REJECTED - The payment has been rejected or is in such a state that it will never become successful. This category groups the following statuses:
    • CREATED
    • REJECTED
    • REJECTED CAPTURE
    • REJECTED REFUND
    • REJECTED PAYOUT
    • CANCELLED
  • SUCCESSFUL - The payment was not (yet) rejected. Use the payment statuses to determine if it was completed, see Statuses. This category groups the following statuses:
    • PENDING PAYMENT
    • ACCOUNT VERIFIED
    • PENDING FRAUD APPROVAL
    • PENDING APPROVAL
    • AUTHORIZATION REQUESTED
    • CAPTURE REQUESTED
    • REFUND REQUESTED
    • PAYOUT REQUESTED
    • CAPTURED
    • PAID
    • ACCOUNT CREDITED
    • REVERSED
    • CHARGEBACK_NOTIFICATION
    • CHARGEBACKED
    • REFUNDED
  • STATUS_UNKNOWN - The status of the payment is unknown at this moment. This category groups the following statuses:
    • REDIRECTED

Please see Statuses for a full overview of possible values.

tokens string no

This field contains the tokens that are associated with the hosted checkout session/consumer. You can use the tokens listed in this list for a future checkout of the same consumer.

status enum no

This is the status of the hosted checkout. Possible values are:
  • IN_PROGRESS - The checkout is still in progress and has not finished yet
  • PAYMENT_CREATED - A payment has been created
  • CANCELLED_BY_CONSUMER - If a consumer cancels the payment on the payment product detail page of the MyCheckout hosted payment pages, the status will change to IN_PROGRESS. Since we understand you want to be aware of a consumer cancelling the payment on the page we host for you, you can choose to get the status CANCELLED_BY_CONSUMER back instead of the status IN_PROGRESS. In order to get the status CANCELLED_BY_CONSUMER back, you need to have the returnCancelState flag enabled in the Create hosted checkout call

Please see Statuses for a full overview of possible values.

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "createdPaymentOutput" : {
            "payment" : {
                "id" : "000000891566072501680000200001",
                "hostedCheckoutSpecificOutput" : {
                    "hostedCheckoutId" : "dbcb004a-1eda-4e83-aa47-1656bcdc3e36",
                    "variant" : "100"
                },
                "paymentOutput" : {
                    "amountOfMoney" : {
                        "amount" : 2345,
                        "currencyCode" : "USD"
                    },
                    "references" : {
                        "paymentReference" : "0"
                    },
                    "paymentMethod" : "card",
                    "cardPaymentMethodSpecificOutput" : {
                        "paymentProductId" : 1,
                        "authorisationCode" : "123456",
                        "card" : {
                            "cardNumber" : "************7977",
                            "expiryDate" : "1220"
                        },
                        "fraudResults" : {
                            "avsResult" : "0",
                            "cvvResult" : "M",
                            "fraudServiceResult" : "no-advice"
                        }
                    }
                },
                "status" : "PENDING_APPROVAL",
                "statusOutput" : {
                    "isCancellable" : true,
                    "statusCode" : 600,
                    "statusCodeChangeDateTime" : "20140717145840",
                    "isAuthorized" : true
                }
            },
            "paymentCreationReferences" : {
                "additionalReference" : "00000089156607250168",
                "externalReference" : "000000891566072501680000200001"
            },
            "tokens" : ""
        },
        "status" : "PAYMENT_CREATED"
    }
    

Response 400 - Bad requestErrorResponse

     Property Type Required Description
errorId string yes

Unique reference, for debugging purposes, of this error response

array yes
List of one or more errors
object no SDK object type: APIError
category string no

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

code string yes

Error code

httpStatusCode integer no

HTTP status code for this error that can be used to determine the type of error

id string no

ID of the error. This is a short human-readable message that briefly describes the error.

message string no

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud

propertyName string no

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

requestId string no

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    
icon_top_1