COcollectly
payment_methods

Get patient payment method(s)

Changed on

Get patient payment method(s)

get/practices/{practice_id}/patients/{patient_id}/payment-methods

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/practices/{practice_id}/patients/{patient_id}/payment-methods
  • Auth
    API key in header Authorization

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

patient_idstring required

Patient ID from your integration who owns the resource

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

OK

collectly_idstring

Unique Collectly resource ID

customer_idstring nullable

Payment method owner's ID in payment provider account (e.g. Stripe)

exp_monthinteger nullable

Payment method expiration month number

exp_yearinteger nullable

Payment method expiration year in YYYY format (e.g. 2024)

external_payment_method_idstring nullable

Payment method ID in payment provider account. This can be the ID of a card or bank account etc.

last4string nullable

Last four numbers of the payment method number

namestring nullable

Display name

patient_idstring required

Patient ID from your integration who owns the resource

status'active' | 'invalid' | 'expired' | 'one_time' | 'no_consent' | 'deleted'

Payment method activity status. Only active payment methods can be used for charging

type'bank_account' | 'amex' | 'diners' | 'discover' | 'eftpos_au' | 'jcb' | 'mastercard' | 'unionpay' | 'visa' | 'unknown'

Card brand or bank account

Changes