Skip to main content

Payment

Base path: /api/data/payment

All payment CRUD endpoints are registered but not yet implemented — handlers are empty stubs.

POST /api/data/payment

Create a new payment record.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.

Payment Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
orderIdstringYesAssociated order ID
methodenumYesPayment method: PAYPAL, CASHAPP_PAY, BTC_INVOICE, VENMO_P2P, CASHAPP_P2P, ZELLE, CHIME, PAYPAL_MANUAL, BTC_MANUAL, BTC_NOWPAYMENTS
statusenumYesPayment status: PENDING, AUTHORIZED, PAID, FAILED, REFUNDED, CANCELLED, pending_payment, awaiting_admin_approval, confirmed, rejected
amountCentsnumberYesPayment amount in cents (non-negative integer)
currencystringYesISO 4217 currency code, 3 chars (default USD)
providerRefstringNoExternal payment provider reference (for BTC_NOWPAYMENTS: the NOWPayments invoice ID)
referenceTextstringNoHuman-readable reference text
confirmedBystringNoUser ID who confirmed the payment (legacy)
confirmedAtdateNoConfirmation timestamp (legacy)
approverUserIdstringNoAdmin who confirmed or rejected a P2P payment
approvedAtdateNoWhen the P2P payment was confirmed
rejectedAtdateNoWhen the P2P payment was rejected
rejectionReasonstringNoReason for P2P payment rejection
customerReferenceNotestringNoVenmo/CashApp note seen by admin during approval
nowpaymentsHostedUrlstringNoBTC_NOWPAYMENTS: hosted invoice URL shown to customer
nowpaymentsDepositAddressstringNoBTC_NOWPAYMENTS: on-chain BTC deposit address
nowpaymentsDepositAmountCryptostringNoBTC_NOWPAYMENTS: expected BTC amount (decimal string)
nowpaymentsCryptoCurrencystringNoBTC_NOWPAYMENTS: crypto ticker (e.g. "btc")
nowpaymentsExpiresAtdateNoBTC_NOWPAYMENTS: invoice expiry timestamp
createdAtdateYesCreation timestamp
updatedAtdateYesLast update timestamp

GET /api/data/payment/:id

Retrieve a payment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


PATCH /api/data/payment/:id

Update a payment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


DELETE /api/data/payment/:id

Delete a payment by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.