Skip to content
Sanmopia Modernization

Prepare a gift-coupon checkout session

Switch to Zen Mode
POST
/gift-coupon-checkout-sessions
curl --request POST \
  --url https://example.com/gift-coupon-checkout-sessions \
  --header 'Content-Type: application/json' \
  --data '{ "checkoutSession": { "giftCouponCheckoutSessionId": "example", "paymentProductPlanCode": "example", "buyerSnapshot": { "partySnapshotId": "example", "displayName": "example", "phoneNumberFingerprint": "example", "memberUserId": "example" }, "receiverSnapshot": { "partySnapshotId": "example", "displayName": "example", "phoneNumberFingerprint": "example", "memberUserId": "example" }, "offerSelection": { "giftCouponOfferKey": "example", "offerCatalogRevisionKey": "example", "displayName": "example", "purchaseAmountKrw": 1, "sourceEvidenceKey": "example" }, "idempotencyKey": "example", "requestedAt": "2026-04-15T12:00:00Z", "status": "awaiting_provider_draft", "providerPaymentDraftId": "example", "sourceLegacyPaymentCouponId": "example" }, "staleUnpaidCutoffAt": "2026-04-15T12:00:00Z" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
PrepareGiftCouponCheckoutSession
object
checkoutSession
required
object
giftCouponCheckoutSessionId
required
string
>= 1 characters
paymentProductPlanCode
required
string
>= 1 characters
buyerSnapshot
required
object
partySnapshotId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
phoneNumberFingerprint
required
string
>= 1 characters
memberUserId
string | null
>= 1 characters
key
additional properties
receiverSnapshot
required
object
partySnapshotId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
phoneNumberFingerprint
required
string
>= 1 characters
memberUserId
string | null
>= 1 characters
key
additional properties
offerSelection
required
object
giftCouponOfferKey
required
string
>= 1 characters
offerCatalogRevisionKey
required
string
>= 1 characters
displayName
required
string
>= 1 characters
purchaseAmountKrw
required
integer
>= 1
sourceEvidenceKey
required
string
>= 1 characters
key
additional properties
idempotencyKey
required
string
>= 1 characters
requestedAt
required
string format: date-time
status
required
string
Allowed values: awaiting_provider_draft awaiting_payment paid superseded cancelled expired
providerPaymentDraftId
string | null
>= 1 characters
sourceLegacyPaymentCouponId
string | null
>= 1 characters
key
additional properties
staleUnpaidCutoffAt
required
string format: date-time
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

200

Section titled “200”

Gift-coupon checkout session plan

Media typeapplication/json
GiftCouponCheckoutSessionPlan
object
checkoutSession
required
object
giftCouponCheckoutSessionId
required
string
>= 1 characters
paymentProductPlanCode
required
string
>= 1 characters
buyerSnapshot
required
object
partySnapshotId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
phoneNumberFingerprint
required
string
>= 1 characters
memberUserId
string | null
>= 1 characters
key
additional properties
receiverSnapshot
required
object
partySnapshotId
required
string
>= 1 characters
displayName
required
string
>= 1 characters
phoneNumberFingerprint
required
string
>= 1 characters
memberUserId
string | null
>= 1 characters
key
additional properties
offerSelection
required
object
giftCouponOfferKey
required
string
>= 1 characters
offerCatalogRevisionKey
required
string
>= 1 characters
displayName
required
string
>= 1 characters
purchaseAmountKrw
required
integer
>= 1
sourceEvidenceKey
required
string
>= 1 characters
key
additional properties
idempotencyKey
required
string
>= 1 characters
requestedAt
required
string format: date-time
status
required
string
Allowed values: awaiting_provider_draft awaiting_payment paid superseded cancelled expired
providerPaymentDraftId
string | null
>= 1 characters
sourceLegacyPaymentCouponId
string | null
>= 1 characters
key
additional properties
supersessionFacts
required
Array<object>
object
supersededGiftCouponCheckoutSessionId
required
string
>= 1 characters
replacementGiftCouponCheckoutSessionId
required
string
>= 1 characters
buyerAuthorityKey
required
string
>= 1 characters
supersededPurchaseAmountKrw
required
integer
>= 1
replacementPurchaseAmountKrw
required
integer
>= 1
supersededAt
required
string format: date-time
reasonCode
required
string
>= 1 characters
key
additional properties
key
additional properties

400

Section titled “400”

Gift-coupon checkout payload is invalid

422

Section titled “422”

Gift-coupon checkout request shape is invalid

503

Section titled “503”

Gift-coupon checkout runtime is unavailable