Enumeration PaymentRequestState

Represents the lifecycle of a payment request.

State transition, note that the CREATED state is client side only and not visible through webhook notifications.

CREATED              -> [SUBMITTED]
SUBMITTED            -> [IN_PROGRESS, PREPARED, SUBMITTED]
PREPARED             -> [IN_PROGRESS, PENDING_CONFIRMATION]
IN_PROGRESS          -> [SUBMITTED, PENDING_CONFIRMATION, AUTHORIZED]
PENDING_CONFIRMATION -> [IN_PROGRESS, AUTHORIZED]
AUTHORIZED
EXPIRED

Enumeration Members

AUTHORIZED CANCELED CREATED EXPIRED IN_PROGRESS PENDING_CONFIRMATION PREPARED SUBMITTED

Enumeration Members

AUTHORIZED

AUTHORIZED: "AUTHORIZED"

The payment request is authorized - and a payment authorization has been created. This is a final state.

CANCELED

CANCELED: "CANCELED"

TThe payment request has been cancelled. This is a final state.

CREATED

CREATED: "CREATED"

Payment request has been created client side, can freely be modified - no state created server side

EXPIRED

EXPIRED: "EXPIRED"

The payment request has expired. This is a final state.

IN_PROGRESS

IN_PROGRESS: "IN_PROGRESS"

The payment flow is in progress - consumer is inside the purchase flow

PENDING_CONFIRMATION

PENDING_CONFIRMATION: "PENDING_CONFIRMATION"

The payment flow has successfully been completed by the consumer and is pending final confirmation to complete the request.

PREPARED

PREPARED: "PREPARED"

The payment request is prepared, but not yet finalized. Must be finalized by calling initiate()

SUBMITTED

SUBMITTED: "SUBMITTED"

Payment request has been submitted to the backend and ready to be initiated or prepared, request can be modified but must be synchronized

Settings

Member Visibility

On This Page

Enumeration Members