api
fundraise

Changed on

Get a Donation

get/api/fundraise/donations/{id}

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/fundraise/donations/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

The ID of the donation to get the donation (can be external ID). In case of external ID, the external ID must be prefixed with 'externalId:'

Response

OK

_idstring required

The ID of the Donation

amountnumber required

The amount of the donation

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required

The currency of the donation

customerIdstring required

The ID of the customer of the donation

fundIdstring required

The ID of the fund of the donation

campaignIdstring

The ID of the campaign of the donation

salesChannelIdstring

The ID of the sales channel of the donation

notesstring

The notes of the donation

externalIdstring

The external ID of the donation

cartItemIdstring

The ID of the cart item from which the donation created

appliedAtstring date-time

An ISO timestamp indicating when the donation was applied. (esp. helpful for donations from external integrations)

sellerIdstring required

The ID of the seller owning the donation

createdAtstring date-time required

An ISO timestamp indicating when the donation was created.

updatedAtstring date-time required

An ISO timestamp indicating when the donation was updated.

Changes