Process Transaction

curl --request POST \
  --url https://api.crowdchange.dev/v2/client/transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "frequency": "<string>",
  "email": "<string>",
  "fundraiser_id": 123,
  "card": {
    "type": "<string>",
    "token": "<string>"
  },
  "billing": {
    "is_foundation": true,
    "title": "<string>",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "custom_data": {},
  "tax_receipt": {
    "title": "<string>",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "tribute": {
    "fundraiser_tribute_id": 123,
    "type": "<string>",
    "honoree": "<string>",
    "message": "<string>",
    "method": "<string>",
    "address": {
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    },
    "email": "<string>",
    "phone": "<string>",
    "name": "<string>",
    "donor_copy": true
  },
  "extra": {
    "mail_receipt": true,
    "donation_setting_item_id": 123,
    "installments": {
      "total_amount": 123,
      "duration": 123,
      "day": 123
    }
  },
  "mail": {
    "same_as_billing": true,
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  }
}
'

{
  "id": 123123,
  "ref_id": "SCXXxxXxxxxxXXXx",
  "amount": 49.95,
  "currency": "USD",
  "currency_symbol": "$",
  "frequency": "once",
  "fundraiser_id": 1,
  "parent_id": null,
  "fundraiser_page_id": null,
  "fundraiser_team_id": null,
  "organization_id": 1,
  "fundraiser_name": "Gala Night",
  "organization_name": "Crowdchange",
  "organization_code": "CrowdchangeID",
  "user_id": 120120,
  "email": "john@example.com",
  "mail": null,
  "statement_descriptor": "XXX*CC XXX",
  "summary": {
    "amount_covered_fee": 1.95,
    "amount_custom_fee": 0,
    "amount_donation": 48,
    "amount_apparel": 0,
    "amount_ticket": 0,
    "amount_registration": 0,
    "amount_sponsor": 0,
    "amount_cards": 0,
    "frequency": "once"
  },
  "upsell": null,
  "promo_code": null,
  "billing_address": {
    "name": "Mr. John Snow",
    "email": "john@example.com",
    "business_name": null,
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "address": "123 Main St",
    "city": "Toronto",
    "state": "ON",
    "zip": "M5V2T6",
    "country": "CA",
    "phone": null
  },
  "dtd": null,
  "created_at": "2024-01-01 12:00:00",
  "status": "received"
}

POST

client

transactions

Process Transaction

curl --request POST \
  --url https://api.crowdchange.dev/v2/client/transactions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "frequency": "<string>",
  "email": "<string>",
  "fundraiser_id": 123,
  "card": {
    "type": "<string>",
    "token": "<string>"
  },
  "billing": {
    "is_foundation": true,
    "title": "<string>",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "custom_data": {},
  "tax_receipt": {
    "title": "<string>",
    "business_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  },
  "tribute": {
    "fundraiser_tribute_id": 123,
    "type": "<string>",
    "honoree": "<string>",
    "message": "<string>",
    "method": "<string>",
    "address": {
      "address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "country": "<string>"
    },
    "email": "<string>",
    "phone": "<string>",
    "name": "<string>",
    "donor_copy": true
  },
  "extra": {
    "mail_receipt": true,
    "donation_setting_item_id": 123,
    "installments": {
      "total_amount": 123,
      "duration": 123,
      "day": 123
    }
  },
  "mail": {
    "same_as_billing": true,
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "country": "<string>"
  }
}
'

{
  "id": 123123,
  "ref_id": "SCXXxxXxxxxxXXXx",
  "amount": 49.95,
  "currency": "USD",
  "currency_symbol": "$",
  "frequency": "once",
  "fundraiser_id": 1,
  "parent_id": null,
  "fundraiser_page_id": null,
  "fundraiser_team_id": null,
  "organization_id": 1,
  "fundraiser_name": "Gala Night",
  "organization_name": "Crowdchange",
  "organization_code": "CrowdchangeID",
  "user_id": 120120,
  "email": "john@example.com",
  "mail": null,
  "statement_descriptor": "XXX*CC XXX",
  "summary": {
    "amount_covered_fee": 1.95,
    "amount_custom_fee": 0,
    "amount_donation": 48,
    "amount_apparel": 0,
    "amount_ticket": 0,
    "amount_registration": 0,
    "amount_sponsor": 0,
    "amount_cards": 0,
    "frequency": "once"
  },
  "upsell": null,
  "promo_code": null,
  "billing_address": {
    "name": "Mr. John Snow",
    "email": "john@example.com",
    "business_name": null,
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "address": "123 Main St",
    "city": "Toronto",
    "state": "ON",
    "zip": "M5V2T6",
    "country": "CA",
    "phone": null
  },
  "dtd": null,
  "created_at": "2024-01-01 12:00:00",
  "status": "received"
}

Body

amount

number

requis

Full amount of transaction in xxx.xx format.

frequency

string

requis

Payment frequency. Allowed values: once, month, year

string

User’s email.

fundraiser_id

integer

requis

Fundraiser / Campaign ID.

card

object

requis

Card information.

Afficher properties

type

string

requis

Allowed values: VI, VISA, MC, AMEX, DC, DISC, JCB, CUP

token

string

requis

Credit card token received from payment processor.

billing

object

requis

Billing information.

Afficher properties

is_foundation

boolean

Whether the payment is on behalf of a foundation.

title

string

Title / Honorifics. For example, Mr. / Miss / Mrs.

business_name

string

Business Name

first_name

string

requis

First Name.

last_name

string

requis

Last Name.

address

string

requis

Street Address.

city

string

requis

City.

state

string

requis

Two letter State or province..

zip

string

requis

Zip or Postal code.

country

string

requis

ISO 3166-1 alpha-2 country code.

custom_data

object

Additional transaction data.

tax_receipt

object

Tax receipt on behalf of another person info.

Afficher properties

title

string

Title / Honorifics. For example, Mr. / Miss / Mrs.

business_name

string

Business Name

first_name

string

First Name.

last_name

string

Last Name.

string

Email.

address

string

Street Address.

city

string

City.

state

string

Two letter State or province..

zip

string

Zip or Postal code.

country

string

ISO 3166-1 alpha-2 country code.

tribute

object

Tax receipt on behalf of another person info.

Afficher properties

fundraiser_tribute_id

integer

Tribute ID.

type

string

Tribute Type. Allowed values: in_honor, in_memory, donation

honoree

string

Honoree.

message

string

Message.

method

string

Delivery method Allowed values: mail, email, sms

address

object

Address.

Afficher properties

address

string

Street Address.

city

string

City.

state

string

Two letter State or province..

zip

string

Zip or Postal code.

country

string

ISO 3166-1 alpha-2 country code.

string

Email.

phone

string

Phone Number.

name

string

Name.

donor_copy

boolean

Send copy to donor.

extra

object

Extra information.

Afficher properties

mail_receipt

boolean

Send receipt by mail

donation_setting_item_id

integer

Impact Statement ID.

installments

object

Fixed installment payment. When enabled, the total donation is split into equal monthly payments. Requires frequency to be once, the fundraiser to have installment payments enabled, and a recurring-capable payment processor (Stripe or Paysafe). The first payment is charged immediately; the rest are charged on the chosen day of each subsequent month. The amount field on the request is ignored and replaced server-side with total_amount / duration.

Afficher properties

total_amount

number

Total donation amount to be split across all installments, in xxx.xx format. Each installment is charged total_amount / duration (rounded to 2 decimals).

duration

integer

Number of monthly installments. Must be one of the durations configured on the fundraiser (defaults to 3, 6, or 12).

day

integer

Day of the month each installment is charged after the first payment. Must be one of the days configured on the fundraiser (defaults to 1 or 15).

mail

object

Mail information.

Afficher properties

same_as_billing

boolean

Address is the same as billing address

address

string

Street Address.

city

string

City.

state

string

Two letter State or province..

zip

string

Zip or Postal code.

country

string

ISO 3166-1 alpha-2 country code.

Response

integer

Transaction ID.

ref_id

string

Reference or confirmation ID from the payment processor.

amount

number

Full amount of the transaction.

currency

string

Currency code.

currency_symbol

string

Currency symbol.

frequency

string

Payment frequency. Allowed values: once, month, year

fundraiser_id

integer

Fundraiser / Campaign ID.

parent_id

integer

Parent transaction ID for recurring or installment payments, otherwise null.

fundraiser_page_id

integer

Personal page ID the transaction is attributed to, if any.

fundraiser_team_id

integer

Team ID the transaction is attributed to, if any.

organization_id

integer

Organization ID.

fundraiser_name

string

Fundraiser / Campaign name.

organization_name

string

Organization name.

organization_code

string

Organization’s custom ID.

user_id

integer

User ID.

string

Donor’s contact email.

mail

object

Mailing address for the receipt, returned only when a mailed receipt was requested. Otherwise null.

Afficher properties

address

string

Street address.

city

string

City.

state

string

State or province.

zip

string

Zip or postal code.

country

string

Country code.

statement_descriptor

string

Statement descriptor that appears on the donor’s card statement.

summary

object

Breakdown of the transaction amount by category.

Afficher properties

amount_covered_fee

number

Processing fee covered by the donor.

amount_custom_fee

number

Custom fees applied to the transaction.

amount_donation

number

Donation amount.

amount_apparel

number

Amount spent on apparel.

amount_ticket

number

Amount spent on tickets.

amount_registration

number

Amount spent on registration.

Amount spent on sponsorships.

amount_cards

number

Amount spent on e-cards.

frequency

string

Payment frequency. Allowed values: once, month, year

upsell

object

Recurring upsell details, when an upsell was presented. Otherwise null.

Promo code applied to the transaction, if any.

billing_address

object

Billing details for the transaction.

Afficher properties

name

string

Full billing name.

string

Billing email.

business_name

string

Business name.

title

string

Title / honorific.

first_name

string

First name.

last_name

string

Last name.

address

string

Street address.

city

string

City.

state

string

State or province.

zip

string

Zip or postal code.

country

string

Country code.

phone

string

Phone number.

dtd

object

Double the Donation employer matching details, when provided. Otherwise null.

Afficher properties

company_id

string

Double the Donation company ID.

entered_text

string

Employer name entered by the donor.

created_at

string

Date and time the transaction was created.

status

string

Transaction status.

Other responses

Status	Description
`400`	Bad Request
`403`	Forbidden

{
  "id": 123123,
  "ref_id": "SCXXxxXxxxxxXXXx",
  "amount": 49.95,
  "currency": "USD",
  "currency_symbol": "$",
  "frequency": "once",
  "fundraiser_id": 1,
  "parent_id": null,
  "fundraiser_page_id": null,
  "fundraiser_team_id": null,
  "organization_id": 1,
  "fundraiser_name": "Gala Night",
  "organization_name": "Crowdchange",
  "organization_code": "CrowdchangeID",
  "user_id": 120120,
  "email": "john@example.com",
  "mail": null,
  "statement_descriptor": "XXX*CC XXX",
  "summary": {
    "amount_covered_fee": 1.95,
    "amount_custom_fee": 0,
    "amount_donation": 48,
    "amount_apparel": 0,
    "amount_ticket": 0,
    "amount_registration": 0,
    "amount_sponsor": 0,
    "amount_cards": 0,
    "frequency": "once"
  },
  "upsell": null,
  "promo_code": null,
  "billing_address": {
    "name": "Mr. John Snow",
    "email": "john@example.com",
    "business_name": null,
    "title": "Mr.",
    "first_name": "John",
    "last_name": "Snow",
    "address": "123 Main St",
    "city": "Toronto",
    "state": "ON",
    "zip": "M5V2T6",
    "country": "CA",
    "phone": null
  },
  "dtd": null,
  "created_at": "2024-01-01 12:00:00",
  "status": "received"
}

Site wide stats

Top Daily Campaigns

⌘I

​Body

​Response

Body

Response