Payment

Table:

payment

Model Version:

88a84f77d17a331c

JSON Schema:

Payment

amountCents

integer

amount charged or refuned

bulkPaymentId

Nullable

string

cardConfirmation

Nullable

string

cardDigits

Nullable

string

cardName

Nullable

string

cardType

Nullable

string

chargeFromPublicPage

boolean

chargeId

Nullable

string

reference for original payment if transaction type is different from charge

checkNumber

Nullable

string

companyId

string

createdDate

date-time

debitCard

boolean

deposit

boolean

disputedPaymentId

Nullable

string

if a payment is a deduction/correction of a disputed payment, here we store link to that original disputed payment

disputedReason

Nullable

string

disputedStatus

Nullable

Warning, NeedsResponse, UnderReview, Refunded, Won, Lost, Unknown

disputedType

Nullable

Deduction, Fee, ReversedDeduction, ReversedFee

duesAndAssessmentsFee

Nullable

number

0 = no fees yet, null = there will be no fees

Primary Key

string

imported

boolean

interchangeFee

Nullable

integer

0 = no fees yet, null = there will be no fees

locationId

string

metadata

Nullable

object

metadata reserved for customers to control

note

string

orderId

string

payerId

Nullable

string

paymentMode

Manual, Online, InPerson

paymentType

Check, Cash, Card, Other, ACH, Financing, PayPal, Venmo, Zelle, Insurance, Warranty, Internal, Mechanical_Installment, Policy, Reconditioning, Vehicle_Service_Contract, Account_Receivable, BNPL, BNPL_Sunbit, Interac_e__Transfer

payoutId

Nullable

string

provider

Nullable

Finix, FirstMile, Manual, Stripe, Sunbit

providerData

Nullable

object

providerFee

Nullable

integer

SM payments fee amount in cents on top of Stripe fee

receiptNumber

integer

recordedDate

Nullable

date-time

the date that the payment was recorded

refundReason

Nullable

Duplicate, Fraudulent, RequestedByCustomer

refunded

Nullable

boolean

refundedAmountCents

Nullable

integer

amount refunded for charge transactions

statementId

Nullable

string

status

Canceled, Failed, Pending, Succeeded

surchargeFee

Nullable

integer

transactionType

Charge, Refund, Transfer, Dispute

transactionalFeeAmountCents

Nullable

integer

amount charged as SM transactional fee (service fee)

updatedDate

Nullable

date-time

userData

Nullable

object