Skip to content
Sanmopia Modernization

Get one backend-owned payment product plan

Switch to Zen Mode
GET
/payment-product-plans/{planCode}
curl --request GET \
  --url https://example.com/payment-product-plans/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
planCode
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Payment product plan

Media typeapplication/json
PaymentProductPlanResponse
object
plan
required
object
planCode
required
string
>= 1 characters
productFamily
required
string
Allowed values: customer_share service_balance pre_reservation gift_coupon payment_change
displayLabel
required
string
>= 1 characters
allowedPaymentMethods
required
Array<string>
>= 1 items
Allowed values: card bank vcnt
obligationPurposes
required
Array<string>
>= 1 items
Allowed values: customer_share_deposit customer_share_balance service_balance pre_reservation_deposit gift_coupon_purchase payment_change_correction
settlementParticipation
required
string
Allowed values: customer_charge service_balance pre_reservation_credit gift_coupon payment_correction not_participating
settlementRealizationPolicy
required
object
realizationTriggers
required
Array<string>
Allowed values: payment_approved virtual_account_issued virtual_account_deposited service_closeout operator_completion coupon_fulfilled correction_completed
ledgerRecognitionTiming
required
string
Allowed values: immediate deferred_until_fulfillment deferred_until_service_close manual_operator_reviewed not_recognized
feeRecognitionBasis
required
string
Allowed values: gateway_gross_amount customer_share_amount coupon_purchase_amount service_balance_amount manual_adjustment_amount none
settlementLineTargets
required
Array<string>
Allowed values: customer_charge service_balance gift_coupon_fee pre_reservation_credit payment_correction non_settlement
freezesCustomerVisibleAmountAfterPayment
required
boolean
laterCatalogChangesCanAlterExposedResult
required
boolean
key
additional properties
refundPolicy
required
object
refundable
required
boolean
operatorReviewRequired
required
boolean
refundWindowDays
required
integer | null
>= 1
key
additional properties
conversionPolicy
required
object
convertibleToReservationPayment
required
boolean
customerVisibleConversion
required
boolean
key
additional properties
cashReceiptPolicy
required
object
merchantOfRecord
required
Allowed values: sanmopia caregiver external_partner
collectionChannel
required
Allowed values: provider_collected direct_to_caregiver external_partner_collected
receiptIssuer
required
Allowed values: provider_on_behalf_of_sanmopia external_partner none
cashReceiptEligible
required
boolean
supportedPurposes
required
Array
Allowed values: income_deduction business_expense_proof
ineligibleReasonCode
required
string | null
>= 1 characters
key
additional properties
priceCatalogReferences
required
Array<object>
object
catalogCode
required
string
>= 1 characters
catalogVersionLabel
required
string
>= 1 characters
quoteComponentCode
required
string
>= 1 characters
obligationPurpose
required
string
Allowed values: customer_share_deposit customer_share_balance service_balance pre_reservation_deposit gift_coupon_purchase payment_change_correction
sourceEvidenceKey
required
string
>= 1 characters
key
additional properties
providerRoutingKey
required
string
>= 1 characters
expirationPolicy
required
Any of:
object
expiresAfterMinutes
required
integer
>= 1
appliesToMethods
required
Array<string>
>= 1 items
Allowed values: card bank vcnt
key
additional properties
key
additional properties
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot read payment product plan catalog

404

Section titled “404”

Payment product plan code was not found

503

Section titled “503”

Payment product plan catalog runtime is unavailable