Server API version 1.0
Java

Results for

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

Statuses

Hosted Checkout statuses

The hostedCheckout API can return two statuses and two status categories, each has their own purpose to aid you to code defensively to future new statuses.

HostedCheckout
statuspaymentOutput
paymentStatusCategorypayment
statusstatusOutput
statusCategory
CANCELLED_BY_CONSUMERN/AN/AN/A
IN_PROGRESSN/AN/AN/A
PAYMENT_CREATEDREJECTEDCREATEDCREATED
CANCELLEDUNSUCCESSFUL
REJECTED
REJECTED_CAPTURE
STATUS_UNKNOWNREDIRECTEDPENDING_PAYMENT
SUCCESSFULPENDING_PAYMENT
ACCOUNT_VERIFIEDACCOUNT_VERIFIED
PENDING_APPROVALPENDING_MERCHANT
PENDING_COMPLETION
PENDING_CAPTURE
PENDING_FRAUD_APPROVAL
AUTHORIZATION_REQUESTEDPENDING_CONNECT_OR_3RD_PARTY
CAPTURE_REQUESTED
CAPTUREDCOMPLETED
PAID
CHARGEBACK_NOTIFICATION
CHARGEBACKEDREVERSED
REVERSED
REFUNDEDREFUNDED

hostedCheckout.status

This is the high–level status of the hosted checkout itself. You use this status to check if a hostedcheckout has resulted in a payment attempt. Possible values are:

hostedCheckout.status description
CANCELLED_BY_CONSUMERThe checkout has been cancelled by the consumer
IN_PROGRESSThe checkout is still in progress and has not finished yet
PAYMENT_CREATEDA payment has been created
Please check the status of the payment to verify if a successful payment has been created. In case this is not the case please note that depending on your setup it is possible that the consumer may create more than one payment attempt during one hostedCheckout session.

hostedCheckout.paymentOutput.paymentStatusCategory

This is the high level status category for a hosted checkout that allows you to determine if the payment that was created was successful or not. In the case of a REDIRECTED payment, we don’t know the final state yet, so in that case the status is STATUS_UNKNOWN. Possible values are (please note that refund, payout and capture statuses are not listed as these objects can't be created during a hosted checkout):

hostedCheckout.paymentOutput.paymentStatusCategory description
REJECTEDThe payment has been rejected or is in such a state that it will never become successful.
SUCCESSFULThe payment was successful.
STATUS_UNKNOWNThe status of the payment is unknown at this moment.

Payment statuses

The payment statuses are returned as part of the hostedCheckout response, but they are identical to the elements that are returned for a payment processed through a Create payment.

payment
statusstatusOutput
statusCategory
CREATEDCREATED
CANCELLEDUNSUCCESSFUL
REJECTED
REJECTED_CAPTURE
REDIRECTEDPENDING_PAYMENT
PENDING_PAYMENT
ACCOUNT_VERIFIEDACCOUNT_VERIFIED
PENDING_APPROVALPENDING_MERCHANT
PENDING_COMPLETION
PENDING_CAPTURE
PENDING_FRAUD_APPROVAL
AUTHORIZATION_REQUESTEDPENDING_CONNECT_OR_3RD_PARTY
CAPTURE_REQUESTED
CAPTUREDCOMPLETED
PAID
CHARGEBACK_NOTIFICATION
CHARGEBACKEDREVERSED
REVERSED
REFUNDEDREFUNDED

paymentOutput.payment.status

This is the actual status of the payment object that was created during the hosted checkout in a human-readable form. This is the most detailed status of a payment object. The status a payment can reach depends greatly on the payment product used by the consumer to complete the payment and in some cases also on your configuration and/or flags submitted in the Create payment or the Create HostedCheckout API call. It is possible that due to enhancements or new payment products new statuses are added. Your code should be able to gracefully handle those cases.

Possible values are:

paymentOutput.payment.status description
ACCOUNT_VERIFIEDThe 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_PAYMENTInstructions 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 single capturing of the funds. Transactions in this state can be captured only once.
PENDING_COMPLETION The transaction needs to be completed. Transactions in this state can be completed only once.
PENDING_CAPTURE The transaction is awaiting approval from you to proceed with the (partial) capturing of the funds. Transactions in this state can be captured in partial captures.
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

paymentOutput.payment.statusOutput.statusCategory

This is the category of the payment status of the payment object that was created. In the state transition diagrams that can be seen on the payment product pages these are the names of the bands that the status falls in. This allows you to build logic that will not break when we add a new status to a category. It is less likely that we will add new categories vs statuses. In case your system encounters a status that it is unfamiliar with you should have logic that will instead use this field as a fall-back.

Possible values are:

paymentOutput.payment.statusOutput.statusCategory description
CREATED The transaction has been created. This is the initial state once a new payment, payout or refund is created. No action from you is required at this state.
PENDING_PAYMENT The payment is waiting on consumer action. No action from you is required at this state.
ACCOUNT_VERIFIED The account has been verified. This is final state for the transaction, no action is required from you.
PENDING_MERCHANT The transaction is awaiting your approval to proceed with the payment, payout or refund.
PENDING_CONNECT_OR_3RD_PARTY The transaction is in the queue to be processed and no action from you is required at this stage.
COMPLETED The transaction has completed. No action from you is required at this state.
REVERSED The transaction has been reversed. You might want to dispute the chargeback.
REFUNDED The transaction has been refunded. No action from you is required at this state.
UNSUCCESSFUL The transaction has been rejected or is in such a state that it will never become successful. No action from you is required at this state.

The response also contains a statusCode. This field holds the status as returned by either the GlobalCollect or the Ogone platform. This is returned to aid migrating merchants, but should not be used to build business logic on as this field will eventually be deprecated.

Refund statuses

The refund statuses apply to all refund objects that have been created using the Refund API.

refund
statusstatusOutput
statusCategory
CREATEDCREATED
CANCELLEDUNSUCCESSFUL
REJECTED
PENDING_APPROVALPENDING_MERCHANT
REFUND_REQUESTEDPENDING_CONNECT_OR_3RD_PARTY
CAPTUREDCOMPLETED
REFUNDEDREFUNDED

refundResponse.status

This is the actual status of the refund object that was created in a human-readable form. This is the most detailed status of a refund object. The status a refund can reach depends greatly on the payment product used by the consumer for the original payment and in some cases also on your configuration and/or flags submitted in the Create refund API. It is possible that due to enhancements or new payment products new statuses are added. Your code should be able to gracefully handle those cases.

Possible values are:

refundResponse.status description
CREATED The transaction has been created. This is the initial state once a new refund is created.
PENDING_APPROVAL The transaction is awaiting approval from you to proceed with the processing of the refund
REJECTED The refund has been rejected
REFUND_REQUESTED The transaction is in the queue to be refunded
CAPTURED We have successfully refunded the consumer and has received an online confirmation from the third party
CANCELLED You have cancelled the refund
REFUNDED We have successfully refunded the consumer

refundResponse.statusOutput.statusCategory

This is the category of the refund status of the refund object that was created. In the state transition diagrams that can be seen on the payment product pages these are the names of the bands that the status falls in. This allows you to build logic that will not break when we add a new status to a category. It is less likely that we will add new categories vs statuses. In case your system encounters a status that it is unfamiliar with you should have logic that will instead use this field as a fall-back.

Possible values are:

refundResponse.statusOutput.statusCategory description
CREATED The transaction has been created. This is the initial state once a new payment, payout or refund is created. No action from you is required at this state.
PENDING_MERCHANT The transaction is awaiting your approval to proceed with the payment, payout or refund.
PENDING_CONNECT_OR_3RD_PARTY The transaction is in the queue to be processed and no action from you is required at this stage.
COMPLETED The transaction has completed. No action from you is required at this state.
REFUNDED The transaction has been refunded. No action from you is required at this state.
UNSUCCESSFUL The transaction has been rejected or is in such a state that it will never become successful. No action from you is required at this state.

The response also contains a statusCode. This field holds the status as returned by either the GlobalCollect or the Ogone platform. This is returned to aid migrating merchants, but should not be used to build business logic on as this field will eventually be deprecated.

Capture statuses

The capture statuses apply to all capture objects that have been created using the Capture API.
captures
statusstatusOutput
statusCategory
CANCELLED UNSUCCESSFUL
REJECTED_CAPTURE
REVERSED
CAPTURE_REQUESTED PENDING_CONNECT_OR_3RD_PARTY
CAPTURED COMPLETED

captureResponse.status

This is the actual status of the refund object that was created in a human-readable form. This is the most detailed status of a refund object. The status a refund can reach depends greatly on the payment product used by the consumer for the original payment and in some cases also on your configuration and/or flags submitted in the Create refund API. It is possible that due to enhancements or new payment products new statuses are added. Your code should be able to gracefully handle those cases.

Possible values are:

captureResponse.status description
REJECTED_CAPTURE The capture has been rejected
REVERSED The capture has been reversed
CAPTURE_REQUESTED The capture is in the queue to be captured
CAPTURED The transaction has been captured and we have received online confirmation
CANCELLED You have cancelled the capture

captureResponse.statusOutput.statusCategory

This is the category of the capture status of the capture object that was created. In the state transition diagrams that can be seen on the payment product pages these are the names of the bands that the status falls in. This allows you to build logic that will not break when we add a new status to a category. It is less likely that we will add new categories vs statuses. In case your system encounters a status that it is unfamiliar with you should have logic that will instead use this field as a fall-back.

Possible values are:

captureResponse.statusOutput.statusCategory description
PENDING_CONNECT_OR_3RD_PARTY The capture is in the queue to be processed and no action from you is required at this stage.
COMPLETED The capture has completed. No action from you is required at this state.
UNSUCCESSFUL The capture has been rejected or is in such a state that it will never become successful. No action from you is required at this state.

The response also contains a statusCode. This field holds the status as returned by either the GlobalCollect or the Ogone platform. This is returned to aid migrating merchants, but should not be used to build business logic on as this field will eventually be deprecated.

Payout statuses

The payout statuses apply to all refund objects that have been created using the Create Payout API.
payout
statusstatusOutput
statusCategory
CREATEDCREATED
CANCELLEDUNSUCCESSFUL
REJECTED
REJECTED_CREDIT
REVERSEDREVERSED
PENDING_APPROVALPENDING_MERCHANT
PAYOUT_REQUESTEDPENDING_CONNECT_OR_3RD_PARTY
ACCOUNT_CREDITEDCOMPLETED

payoutResponse.status

This is the actual status of the payout object that was created in a human-readable form. This is the most detailed status of a payout object. The status a payout can reach depends greatly on the payment product used by the consumer for the original payment and in some cases also on your configuration and/or flags submitted in the Create Payout API. It is possible that due to enhancements or new payout solutions new statuses are added. Your code should be able to gracefully handle those cases.

Possible values are:

payoutResponse.status description
CREATED The transaction has been created. This is the initial state once a new payout is created.
PENDING_APPROVAL The transaction is awaiting approval from you to proceed with the paying out of the funds
REJECTED The payout has been rejected
PAYOUT_REQUESTED The transaction is in the queue to be payed out to the consumer
ACCOUNT_CREDITED We have successfully credited the consumer
REJECTED_CREDIT The credit to the account of the consumer was rejected by the bank
CANCELLED You have cancelled the payout
REVERSED The payout has been reversed and the money is returned to your balance

payoutResponse.statusOutput.statusCategory

This is the category of the payout status of the payout object that was created during the hosted checkout. In the state transition diagrams that can be seen on the payment product pages these are the names of the bands that the status falls in. This allows you to build logic that will not break when we add a new status to a category. It is less likely that we will add new categories vs statuses. In case your system encounters a status that it is unfamiliar with you should have logic that will instead use this field as a fall-back.

Possible values are:

payoutResponse.statusOutput.statusCategory description
CREATED The transaction has been created. This is the initial state once a new payment, payout or refund is created. No action from you is required at this state.
PENDING_MERCHANT The transaction is awaiting your approval to proceed with the payment, payout or refund.
PENDING_CONNECT_OR_3RD_PARTY The transaction is in the queue to be processed and no action from you is required at this stage.
COMPLETED The payout has completed. No action from you is required at this state.
REVERSED The payout has been reversed.No action from you is required at this state, other than contacting your customer to notify them of the failure and the collection of potentially other/correct payout details.
UNSUCCESSFUL The payout has been rejected or is in such a state that it will never become successful. No action from you is required at this state, other than contacting your customer to notify them of the failure and the collection of potentially other/correct payout details.

The response also contains a statusCode. This field holds the status as returned by either the GlobalCollect or the Ogone platform. This is returned to aid migrating merchants, but should not be used to build business logic on as this field will eventually be deprecated.
icon_top_1