Skip to main content
POST
Record a donation

Authorizations

Authorization
string
header
required

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

Body

application/json
amount_cents
integer
required

The amount in whole cents: 5000 is $50.00. Not a decimal.

Required range: x >= 1
currency
string
default:usd

A currency code. Stored as you send it.

person_id
string

The donor, one of your people. Wins over donor_email when both are sent.

donor_email
string<email>

The donor's email, when you do not have their person ID. See the operation's description for what happens when it matches nobody.

donor_name
string

Used only when donor_email creates a new person: the first word becomes the first name and the rest the last name.

campaign_id
string

The campaign the gift was given to.

donation_type
enum<string>
default:one_time
Available options:
one_time,
recurring,
post_adoption_bump,
upsell
recurring_schedule
object

Details of a recurring gift's schedule, as keys and values of your choosing. Can only be set when the gift is recorded.

payment_gateway
enum<string> | null

How the money came.

Available options:
stripe,
paypal,
square,
zelle,
cashapp,
venmo,
other,
null
gateway_reference
object

Your payment processor's references for the gift, such as a charge ID. Gifts imported with a reference carry it as external_id, and a later import skips a row whose external_id is already here.

status
enum<string>
default:completed

Only completed gifts count towards a campaign, a donor's giving or the donors list.

Available options:
pending,
completed,
failed,
refunded
donated_at
string<date>

The day of the gift. Today unless you say. A timestamp is cut to its date.

custom_fields
object

Values for your own donation fields, by field key. Every field marked required must be here, and a key that is not one of your fields is refused.

fundraising_page_id
string | null

The fundraising page the gift was given on. Its campaign becomes the gift's campaign; naming a different campaign_id beside it is refused.

department_id
string | null

The part of the rescue it belongs to, one of your departments. Left out, it is its campaign's, else your default for gifts.

Response

The donation, as it was recorded.

id
string
required
amount_cents
integer
required

The amount in whole cents: 5000 is $50.00.

currency
string
required
donation_type
enum<string>
required
Available options:
one_time,
recurring,
post_adoption_bump,
upsell
status
enum<string>
required

Only completed gifts count towards a campaign, a donor's giving or the donors list.

Available options:
pending,
completed,
failed,
refunded
donated_at
string
required

The day of the gift, YYYY-MM-DD.

created_at
string<date-time>
required

When it was recorded.

updated_at
string<date-time>
required
tenant_id
string

Your organization's ID.

person_id
string | null

The donor. Null for an anonymous gift.

campaign_id
string | null
recurring_schedule
object | null
payment_gateway
enum<string> | null

How the money came.

Available options:
stripe,
paypal,
square,
zelle,
cashapp,
venmo,
other,
null
gateway_reference
object
custom_fields
object
fund_id
string | null

The fund the GIVER designated this gift to, if any. See Fund.

appeal_id
string | null

The appeal the organization recorded this gift against, if any. A gift created with an appeal and no campaign takes the appeal's default campaign. See Appeal.

dedication_type
enum<string> | null

Whether this gift is in honor of somebody living or in memory of somebody who has died. A type requires dedication_name, and a name requires a type: both halves are refused on their own, because "in memory of" with nobody named cannot be written on a receipt.

Available options:
honor,
memory,
null
dedication_name
string | null

Who the gift is for. Often an animal.

Maximum string length: 200
dedication_note
string | null

What the giver asked to be said, as they typed it.

Maximum string length: 2000
dedication_notify_email
string | null

Somebody to tell, when the giver asked for that. A gift taken through the organization’s own donation form emails them once the money has gone through; a gift recorded through this API or by hand does not.

dedication_notified_at
string<date-time> | null

When that note went out. Read only.

fair_market_value_cents
integer | null

The value of goods or services the donor received, in whole cents. THREE STATES, NOT TWO: null means nobody has recorded a value and a receipt says nothing either way; 0 means the donor received nothing in return; a number means they received goods or services worth that. Only written when the key is present in the body, so a request about something else never turns one into the other.

Required range: x >= 0
donor_first_name
string | null

The giver's FIRST name, on the list only, for a screen projected at an event. Never a surname: a room full of strangers is the most public place a gift appears. Null for a gift with no person on it.

donor_name
string | null

On the list only: the giver's whole name, or their email address when they have no name on file. Null for a gift with no person on it.

fundraising_page_id
string | null

The supporter's or team's fundraising page the gift was given on, if any. The gift counts for the page and for its campaign.

department_id
string | null

The part of the rescue it belongs to: the one it was given, else its campaign's, else your default for gifts. Copied when the gift is recorded, so a campaign changed later leaves it as it is.