add donation

post https://api.raisely.com/v3/donations

Record a donation processed elsewhere in Raisely. These donations are recorded with a type of OFFLINE in Raisely to indicate they were processed externally.

Note: Adding an offline donation does not automatically send a receipt. You need to call the resend API to issue a receipt for an offline donation after it has been added to Raisely.

For custom components:

RaiselyComponents.api.all('donations').post(data = {}, params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

data

object

address1

string

Line 1 of an address

address2

string

Line 2 of an address

amount

integer

required

The total amount of the donation being made

amountRefunded

integer

Total amount refunded to the donor

anonymous

boolean

Does the donor wish to be anonymous

campaignAmount

integer

Transaction amount in the currency of the campaign

campaignDisplayTotal

integer

The total contribution in cents of this donation to the campaign total, in the campaign currency

campaignFee

integer

Fee paid to Raisely in the currency of the campaign

campaignRaisely

integer

Raisely fee in the currency of the campaign

campaignUuid

string

Unique identifier for the record

card

string

ID of the payment method used (from the payment gateway)

cardPreview

integer

Last 4 digits of the card

charge

string

ID for the charge (from the payment gateway)

country

string

createdAt

string

Date the record was created

currency

string

required

3 letter currency code

currencySymbol

string

The symbol of the currency

customer

string

The customer ID (assigned by the payment gateway)

date

string

The date and time (in ISO8601 format) the donation was received by the organisation (only for OFFLINE donations)

declineCode

string

The decline code from Stripe associated with this donation, if applicable

displayTotal

integer

The total contribution in cents of this donation to the campaign total, in the donation currency

donationTotal

integer

The total donation amount

string

required

Email address of the donor

fee

integer

The fee paid to Raisely

feeOptIn

boolean

True if the donor chose to pay the Raisely fee

firstName

string

The first name of the person

forRegistration

string

Not null values indicate this transaction has been set aside to pay for an upcoming registration

fullName

string

The full name of the person

gatewayVersion

string

Gateway Version of donation method, if any

giftAidText

string

The Gift Aid text that the donor saw and agreed to

gst

integer

GST on the Raisely fee (always in AUD)

integer

Simple ID for the donation

includesGiftAid

boolean

Gift aid donation included

ipNumber

string

IP Address of the donor

isExpress

boolean

Indicates whether this donation was made via an express payment flow

items

array of objects

The donation items associated with this donation

items

object

amount

integer

The amount spent on the item in the currency of the donation

amountRefunded

integer

The total amount refunded in cents for this line item, in the donation currency.

attendance

string

Whether the donation item (ticket) has been checked in

CHECKED_IN VALID

bundleItemId

integer

For products purchased as part of a bundle, this specifies the item id of the bundle itself.

campaignAmount

integer

The amount spent on the item in the currency of the campaign

createdAt

string

ISO8601 created timestamp

description

string

Description of the item

includeInTotals

boolean

If false, the amount is not included in receipts as part of the total donation

itemId

string

The item ID / reference

originalAmount

integer

The total amount of this line item in cents prior to any refunds, in the donation currency. Amount is tax inclusive.

perkUuid

string

Deprecated

private

object

Has additional fields

productUuid

string

The uuid for the associated product or ticket.

public

object

Has additional fields

quantity

integer

If multiple of the item, the number of items claimed

status

string

The status of the donation item

ISSUED CANCELLED

type

string

The item type. For most manual API calls, you should use the value OTHER.

DONATION REGISTRATION OTHER TICKET DISCOUNT

updatedAt

string

ISO8601 created timestamp

uuid

string

Unique identifier for the item

itemTypes

array of strings

One or more of DONATION, REGISTRATION, TICKET or OTHER

itemTypes

lastName

string

The last name of the person

message

string

Message from the donor

method

string

required

The payment gateway used

CREDIT_CARD PAYPAL APPLE_PAY OFFLINE CUSTOM STRIPE_INTENT FACEBOOK

methodType

string

The type of payment method used, to distinguish between card, direct debit and digital wallet payments.

mode

string

LIVE or TEST

LIVE TEST

orderTotal

integer

The total order amount

orderUuid

string

Unique identifier for the record

phoneNumber

string

Phone number of the donor

postcode

string

Postal code of the donor

preferredName

string

The name that the person prefers to be called

private

object

Private values for this record

Has additional fields

processing

string

If this is a one time or recurring donation

ONCE RECURRING

profile

object

profileUuid

string

Unique identifier for the record

providerRaisely

integer

Raisely fee in the currency of the provider

public

object

Public values for this record

Has additional fields

publicAmount

integer

Raisely fee in the currency of the provider (as dollars)

publicFee

integer

Raisely fee in the currency of the provider (as dollars)

publicTotal

integer

Raisely fee in the currency of the provider (as dollars)

state

string

status

string

Status of the payment

OK FAILED PENDING REFUNDED DELETED

suburb

string

swiftAidStatus

string

Status of donation on SwiftAid

OK FAILED PENDING DELETING DELETED

taxRate

number

The tax percentage used to calculate the tax total

taxTotal

integer

The total tax charged in cents within items on this donation, in the donation currency

taxType

string

The type of tax (inclusive or exclusive)

token

string

The payment token from the gateway

total

integer

The total transaction amount paid by donor

type

string

required

ONLINE or OFFLINE

ONLINE OFFLINE

updatedAt

string

Date the record was last updated

usedSwiftAid

boolean

Swiftaid used to process Gift Aid

user

object

userId

integer

The id of the Raisely user associated with this donation

userUuid

string

Unique identifier for the record

uuid

string

Unique identifier for the record

Language

Credentials

Bearer

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.raisely.com/v3/donations \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "data": {
8
    "method": "CREDIT_CARD",
9
    "type": "ONLINE"
10
  }
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The created Donation record

400The request requires a body, but the body was missing

401Authorization credentials were missing or invalid

403The user is authenticated, but is not allowed to perform the requested operation

404One of the records needed to complete the request could not be found

409The operation cannot be completed because it would result in a duplicate record

410The requested record no longer exists, or that API has been deprecated

412Operation cannot proceed with the record in it's current state

429You have made too many requests to the given endpoint, please try again later

500An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com