Skip to content
Sanmopia Modernization

Decide cash-receipt eligibility from backend-owned product policy

Switch to Zen Mode
POST
/payment-product-plans/{planCode}/cash-receipt-eligibility-decisions
curl --request POST \
  --url https://example.com/payment-product-plans/example/cash-receipt-eligibility-decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "obligationPurpose": "customer_share_deposit", "requestState": "not_requested", "purpose": "income_deduction", "registrationIdentityReference": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Payment Cash Receipt Eligibility Request
object
obligationPurpose
required
Allowed values: customer_share_deposit customer_share_balance service_balance pre_reservation_deposit gift_coupon_purchase payment_change_correction
requestState
required
Allowed values: not_requested requested unknown
purpose
required
Allowed values: income_deduction business_expense_proof unknown
registrationIdentityReference
string | null
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

200

Section titled “200”

Backend cash-receipt eligibility decision

Media typeapplication/json
Payment Cash Receipt Eligibility Response
object
decisionState
required
Allowed values: not_requested accepted rejected
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
acceptedPurpose
required
string | null
Allowed values: income_deduction business_expense_proof
denialReasonCode
required
string | null
>= 1 characters
providerIssueAllowed
required
boolean
key
additional properties

400

Section titled “400”

Product, obligation, or issue request is invalid

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor session is inactive

503

Section titled “503”

Payment product plan catalog runtime is unavailable