provider
billing
public

Create Payin Config

post/billing/payment-plan/payin-config

Request

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

paymentAmountinteger nullable
savePaymentMethodboolean
textReceiptboolean
paymentMedium'POS' | 'VIRTUAL_TERMINAL' | 'PAYMENT_LINK' | 'PAYMENT_PLAN' | 'SUBSCRIPTION' | 'SAVED_PAYMENT_METHOD' | 'MEMBERSHIP' | 'CASH' | 'CHECK' | 'CARE_CREDIT' | 'PATIENT_CREDIT' required

Payment medium types supported by the system.

These fall into two categories:

  1. Payment Processor Mediums: Require Rainforest/Stripe payin (card processing)
  2. External Settlement Mediums: Settled outside the system (cash, check, etc.)
isSurchargedboolean
locationIdstring nullable
creatorIdstring nullable
membershipIdstring nullable
membershipStartDatestring date-time nullable
soldByProviderIdstring nullable
merchantAccountIdstring nullable

Response

Successful Response

sessionKeystring required
payinConfigIdstring required
sandboxboolean required

Changes

No recorded changes to this operation across all 2 revisions of this API.