Get reservation payment workflow progress

GET

/reservation-payment-workflow-requests/{paymentWorkflowRequestId}

const url = 'https://example.com/reservation-payment-workflow-requests/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/reservation-payment-workflow-requests/example

Parameters

Path Parameters

paymentWorkflowRequestId

required

string

>= 1 characters

Responses

200

Reservation payment workflow progress

application/json

ReservationPaymentWorkflowRequest

object

paymentWorkflowRequestId

required

string

>= 1 characters

paymentId

required

string

>= 1 characters

amountKrw

required

integer

>= 1

action

required

string

Allowed values: verify_paid_payment cancel_payment refund_payment

workflowStatus

required

string

Allowed values: requested accepted running completed failed cancelled

gatewayCode

required

string | null

>= 1 characters

gatewayMessage

required

string | null

>= 1 characters

approvedChargeFinalizationStatus

required

string | null

Allowed values: charge_finalized already_finalized

finalizedChargeSnapshotId

required

string | null

>= 1 characters

settlementContinuationStatus

required

string | null

Allowed values: workflow_started workflow_already_started waiting_for_financial_facts settlement_already_completed blocked

settlementContinuationWorkflowRequestId

required

string | null

>= 1 characters

settlementContinuationReason

required

string | null

>= 1 characters

failureReason

required

string | null

>= 1 characters

lastTransitionAt

required

string | null format: date-time

requestedAt

required

string format: date-time

updatedAt

required

string format: date-time

key

additional properties

404

Reservation payment workflow request not found

503

Reservation payment workflow reader is unavailable