CreateDepositAddress

post

https://public-api.tgbwidget.com/v1/deposit-address

This endpoint is used to create a crypto Deposit Address for Donation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

organizationId

integer

required

≥ 1

Organization ID. You can get it from GetOrganizationsList method

pledgeAmount

string

required

Amount of donation. Should be a string with decimal point

receiptEmail

string

receiptEmail is optional. The Giving Block won't send receipt email If organization has isReceiptEnabled as false (available in response from GetOrganizationsList method) or your API account has default setting that tells us to not send any receipt emails for transactions created through the API. In case if you need The Giving Block to send receipt emails - ask us to set up your API account accordingly and make sure you send receiptEmail in CreateDepositAddress request.

firstName

string

Donor's first name

lastName

string

Donor's last name

addressLine1

string

Donor's address line 1

addressLine2

string

Donor's address line 2

country

string

Donor's country

state

string

Donor's state

city

string

Donor's city

zipcode

string

Donor's zip code

fundsDesignation

uuid

Funds designation. Should be a designation UUID, provided in fundsDesignations array of GetOrganization response. Used if Designations are enabled for the organization

honoreeEmail

string

Honoree email. Used for donation that is dedicated to a friend or loved one

honoreeName

string

Honoree name. Used for donation that is dedicated to a friend or loved one

campaignId

string

Campaign ID

employer

string

occupation

string

isDonorRetired

boolean

isAnonymous

boolean

required

If donation is not anonymous - fields firstName, lastName, addressLine1, addressLine2, country, state, city, zipcode are required.

pledgeCurrency

string

required

Currency code

affirmationsAccepted

boolean

Indicates the donor has accepted required legal self-affirmations.

affirmationsAcceptedVersion

string

Version of the legal self-affirmation accepted by the donor.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json

200OK

400Bad Request

401Unauthorized

500Internal Server Error