API Reference

Get host credit card settings details

This API is used to get host credit card setting details. This API returns data like stripeConnected , stripeActivated , connectButtonEnabled , allowConnectingSquarePayments and many more. To get this API we need to pass the authentication key to authenticate the user. This API is used on the payment processing page.

Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

stripeConnected

Returns a boolean value. If Stripe is connected, value returns true, otherwise false.

stripeActivated

Returns a boolean value. If Stripe is activated, value returns true, otherwise false.

connectButtonEnabled

Returns a boolean value. If Connect button is enabled, value returns true, otherwise false.

allowConnectingSquarePayments

Returns a boolean value. If connecting Square payment is allowed, value returns true, otherwise false.

paymentGateway

This determines the payment gateway to which event host has connected the event to receive payments.

stripeAccountEmail

Contains a Stripe account email. If not passed, will be updated as the empty string.

stripeAccountName

Contains the Stripe account name. If not passed, will be updated as the empty string.

creditCardEnabled

If credit card is not enabled, will be updated as default false.

processingFeesToPurchaser

Will pass IF processing fees to purchaser is enabled AND if stripeConnected is true, otherwise this value will not be stored in DB and will not pass, will be updated as default false.

ccRequireForBidConfirm

If a credit card is required for bid confirmation, will pass, otherwise will be updated as default false.

taxId

Tax id number, if not passed will be updated as the empty string.

Language
Credentials
Header
Click Try It! to start a request and see the response here!