GetWidgetUrl

post

https://public-api.tgbwidget.com/v1/organization/{id}/widget-url

Provides endpoint by which partners are able to get URL to Donation Form where donor will finalize payment/donation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

float

required

≥ 1

Body Params

uiVersion

float

Defaults to 2

Please ensure you are using the latest UI version. 2 - is the latest UI version and used by default

externalId

string

Allows passing a specific ID for this transaction (for example, your own system Transaction ID)

defaultCryptocurrency

string

Allows setting the cryptocurrency you would like to display by default

defaultCryptoAmount

float

≥ 0

Allows setting the cryptocurrency amount you would like to display by default

defaultDafAmount

integer

≥ 0

Allows setting the donor-advised-fund amount you would like to display by default

defaultAmount

float

≥ 0

[Deprecated] Please use one of the above parameters

cryptoReturnUrl

string

After a crypto donation is complete, the donor will be navigated to the specified URL

cardReturnUrl

string

After a card donation is complete, the donor will be navigated to the specified URL

stockReturnUrl

string

After a stock donation is complete, the donor will be navigated to the specified URL

dafReturnUrl

string

After a DAF donation is complete, the donor will be navigated to the specified URL

achReturnUrl

string

After an ACH donation is complete, the donor will be navigated to the specified URL

returnUrl

string

[Deprecated] Please use one of the above parameters

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