COcollectly
patient_checkout

Interrupt current patient's checkout

Changed on

Interrupt current patient's checkout

delete/practices/{practice_id}/patients/{patient_id}/checkout/{patient_checkout}

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}/checkout/{patient_checkout}
  • 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

patient_checkoutstring required

Resource Identifier

Response

OK

auto_charge_enabledboolean nullable

If true the payment method can be used without limits for auto-pay otherwise used limits from last signed consent

bank_account_idstring nullable
bank_account_maskstring nullable
bank_account_namestring nullable
bank_account_subtypestring nullable
bank_account_typestring nullable
bank_idstring nullable
bank_namestring nullable
companyunknown
countrystring nullable
created_atunknown
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.

fingerprintstring nullable

Stripe fingerprint for card_present

fundingstring nullable
idstring
is_hsa_payment_methodboolean
last4string nullable

Last four numbers of the payment method number

last_signed_consentunknown
modified_atunknown
namestring nullable

Display name

patientunknown
plaid_access_tokenstring nullable
priorityinteger nullable

Collectly attempts to charge payment methods in order from the highest to the lowest priority

provided_card_typestring nullable
sourcestring

Source of the payment method

source_terminalunknown
source_userunknown
statusstring nullable

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

wallet_type'amex_express_checkout' | 'apple_pay' | 'google_pay' | 'masterpass' | 'samsung_pay' | 'sunbit' | 'visa_checkout' | 'link' | 'cash' | 'check' | 'athena_ccp' nullable

Changes