ZRM Docs
API ReferencePayment

payment.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
invoiceIdstringYesID of the associated invoice
amountnumberYesAmount
paymentMethodenum(stripe, check, ach, wire, cash, other)YesPayment method
currencystringYes"USD"Currency
statusenum(pending, processing, completed, failed, refunded)Yes"pending"Status
stripePaymentIntentIdstringNoID of the associated stripe payment intent
stripeChargeIdstringNoID of the associated stripe charge
referencestringNoReference
paidAtstring.date-timeNoPaid at
notesstringNoNotes
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "invoiceId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": 0,
  "paymentMethod": "stripe",
  "currency": "USD",
  "status": "pending",
  "stripePaymentIntentId": "550e8400-e29b-41d4-a716-446655440000",
  "visibilityMode": "global"
}

On this page