Skip to main content
POST
Create Payment Method

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

patient_id
string
required

ID of the patient to add the payment method to

Body

application/json
paymentMethodId
string
required
paymentMethodConfigId
string
required
fingerprint
string | null
required
methodType
string
required
card
RainforestCard · object | null
required

The card used to pay for the payin

ach
RainforestACH · object | null
required

The ACH used to pay for the payin

applePay
ApplePay · object | null
required
billingContact
BillingContact · object | null
required
metadata
Metadata · object
required
createdAt
string
required
updatedAt
string
required

Response

Successful Response

id
string
required
patientId
string | null
required
rainforestPaymentMethodId
string
required
brand
string | null
required
last4
string | null
required
expMonth
integer | null
required
expYear
integer | null
required
accountHolderType
string | null
required
accountNumberLast4
integer | null
required
bankName
string | null
required
routingNumber
integer | null
required
description
string | null
required
type
enum<string> | null
required
Available options:
CARD,
ACH,
APPLE_PAY
isDefault
boolean
default:false
isArchived
boolean
default:false