API Reference
  1. One Church Software API
  2. Forms

Record entry payment

post
https://{tenant}.onechurchsoftware.com/api/forms//entries//payments

Records a cash or check payment against a form entry that carries an outstanding balance —
works for any costed entry, even after the form's pay-at-the-door option is switched off.

Required permission: AcceptFormPayment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the form the entry belongs to.

int32
required
≥ 1

The id of the entry being paid.

Body Params

The amount, method (cash/check), and optional note.

double
required

The amount being recorded. Must be greater than zero and no more than the remaining balance.

method
object | null
required

The payment method — only cash or check (by code) are accepted.

string | null

An optional note stored on the transaction.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Updated about 7 hours ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 7 hours ago

Did this page help you?