Create a donation

POST 
/v1/donations

Creates a new Donation of type direct. We will request payment from you for the Donations aggregated over a period. Goodstack and our associated foundations will then handle the ongoing safe and efficient disbursement of funds to the nonprofit.

Please note that if you are creating with a userId and no organisationId the user must be already supporting an organisation.

Request

Header Parameters

Idempotency-Key string

Idempotency key.

application/json

Body

required

oneOf

DirectDonation with Organisation ID

amount integerrequired

Amount to be donated. A positive integer representing how much to donate in the smallest currency unit, for example 100 pence to donate £1.00.

Example: 120

currencyCode stringrequired

Three-letter ISO currency code. Only currency codes supported by our foundations will be accepted.

Example: GBP

organisationId stringrequired

firstName string

Possible values: <= 255 characters

lastName string

Possible values: <= 255 characters

email string

Possible values: <= 255 characters

consentedToBeContactedByOrg string

Possible values: [yes, no]

anonymous string

Possible values: [yes, no]

metadata object

Key-value data that you can attach to a Donation.

Example: {"key1":"value1","key2":"value2"}

DirectDonation with User ID

amount integerrequired

Example: 120

currencyCode stringrequired

Three-letter ISO currency code.

Example: GBP

userId stringrequired

Example: user_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

organisationId string

firstName string

Possible values: <= 255 characters

lastName string

Possible values: <= 255 characters

email string

Possible values: <= 255 characters

consentedToBeContactedByOrg string

Possible values: [yes, no]

anonymous string

Possible values: [yes, no]

metadata object

Key-value data that you can attach to a Donation.

Example: {"key1":"value1","key2":"value2"}

Responses

200

Successfully created a Donation

application/json

Schema

Schema

data

object

id string

Example: donation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

userId stringnullable

organisationId stringnullable

amount integer

Donation amount. A positive integer representing donation amount in the smallest currency unit, for example 100 pence for a donation of £1.00.

Example: 123

currencyCode string

Three-letter ISO currency code

Example: AUD

createdAt date-time

Example: 2020-10-13T17:46:54.000Z

status string

Possible values: [ACTIVE, REQUESTED_PAYMENT, RECEIVED_PAYMENT, DISBURSED, CANCELLED]

firstName stringnullable

Users first name.

lastName stringnullable

Users last name.

email stringnullable

Users email.

consentedToBeContacted stringnullable

Whether the user consented to be contacted by the benefitting organisation.

Possible values: [yes, no]

anonymous stringnullable

Whether the user wants to share their donation publicly or not.

Possible values: [yes, no]

metadata

object

nullable

Key-value data that you can attach to an object.

property name* string

giftAidId stringnullable

cancelledAt date-timenullable

Example: 2020-10-13T17:46:54.000Z

donationRequestId stringnullable

Example: donationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

accountId stringnullable

Example: account_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

type string

Possible values: [direct]

object string
Example: donation

Example (from schema)

{
  "data": {},
  "object": "donation"
}

400

Bad request

application/json

Schema

Schema

error

object

code string

title string

message string

reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

UserNotFound

Donation - User not found

{
  "error": {
    "code": "donation/user_not_found",
    "title": "Bad request",
    "message": "User not found"
  }
}

MissingOrganisation

Donation - Organisation missing

{
  "error": {
    "code": "donation/missing_organisation",
    "title": "Bad request",
    "message": "User must be supporting a cause, or organisationId must be provided"
  }
}

WrongTargetCurrency

Donation - Wrong target currency

{
  "error": {
    "code": "donation/wrong_target_currency",
    "title": "Bad request",
    "message": "This organisation can not accept donations in GBP"
  }
}

WrongPartnerCurrency

Donation - Wrong partner currency

{
  "error": {
    "code": "donation/wrong_partner_currency",
    "title": "Bad request",
    "message": "You can only donate in GBP"
  }
}

CannotAcceptDonations

Donation - Organisation can not accept donations

{
  "error": {
    "code": "donation/cannot_accept_donations",
    "title": "Bad request",
    "message": "This organisation is currently unable to accept donations"
  }
}

GiftAidMissing

Donation - GiftAid missing

{
  "error": {
    "code": "donation/gift_aid_missing",
    "title": "Bad request",
    "message": "Can not find required gift aid for this donation"
  }
}

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...