Skip to main content
POST
Record a payment or refund

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The adoption's ID.

Body

application/json
amount_cents
integer
required

In whole cents, and always positive.

Required range: x >= 1
method
enum<string>
required
Available options:
cash,
check,
card,
ach,
online,
other
kind
enum<string>
default:payment
Available options:
payment,
refund
reference
string

A check number, the last four digits of a card, or anything else to find it by.

received_on
string<date>

Today unless you say.

verified
boolean
default:false

true verifies it now, as the person who made the key: for cash handed over in person.

notes
string
gateway
enum<string>

The payment processor it came through.

Available options:
stripe,
square,
zeffy,
paypal,
venmo,
cashapp,
other
gateway_reference
string

The processor's own ID for the payment. Needs gateway.

Response

The payment, and the adoption's money now.

payment
object
required

One line of an adoption's ledger. A payment is never deleted: a mistake is voided, with a reason, and stays.

amounts
object
required

The money on an adoption, in whole cents, worked out from the ledger each time it is read.