provider
billing

Update Payin Config Metadata

Update metadata for an existing payin config. Only updates payment_medium and save_payment_method fields.

patch/billing/payment-terminal/payin-config/{payin_config_id}/metadata

Request

Path parameters

payin_config_idstring required

Query parameters

payment_medium'POS' | 'VIRTUAL_TERMINAL' | 'PAYMENT_LINK' | 'PAYMENT_PLAN' | 'SUBSCRIPTION' | 'SAVED_PAYMENT_METHOD' | 'MEMBERSHIP' | 'CASH' | 'CHECK' | 'CARE_CREDIT' | 'PATIENT_CREDIT'

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.)

Payment medium to update

save_payment_methodboolean nullable

Save payment method flag to update

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

object required

Changes

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