Skip Main Navigation
Page Content

Checkout and Payout Settings

GET /checkout_settings/countries_currencies/

Get the countries and currencies which are supported by Eventbrite for ticket payment

Returns:
  • countries - a list of supported ISO 3166-1 2-letter countries.
  • currencies - a list of supported ISO 4217 3-letter currencies.
  • default_currencies_by_country - a map of ISO 3166-1 alpha-2 country codes to their default ISO 4217 3-letter currency code.

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /checkout_settings/methods/

Get the available checkout methods to do payments given a country and a currency.

Returns:
  • methods - a list with supported checkout methods given a country and currency combination. Set of possible values: [authnet, eventbrite, offline, paypal].

Parameters

Name Type Required Description
country string Yes Expected methods for Country
currency string Yes Expected methods for Currency

Errors

No endpoint-specific errors

Argument Errors

  • country - MISSING: You did not specify a value for this field.
  • country - UNKNOWN: You passed an invalid value for this field.
  • currency - MISSING: You did not specify a value for this field.
  • currency - UNKNOWN: You passed an invalid value for this field.

GET /checkout_settings/

Searches and returns a list of checkout_settings for the current user as the key checkout_settings.

Parameters

Name Type Required Description
country string No An optional country code by which to filter checkout settings
currency string No An optional currency code by which to filter checkout settings
checkout_methods list No One or more optional (comma-separated) checkout methods by which to filter checkout settings
search_most_recent_event boolean No  

Errors

No endpoint-specific errors

POST /checkout_settings/

Creates a new checkout_settings object belonging to the current user. Two common settings are Eventbrite Payment Processing ( checkout_method = “eventbrite” ) and PayPal ( checkout_method = “paypal” ). In addition to the checkout_method you must provide the country and currency proceeds from the event should be paid to.

For all checkout methods except “eventbrite” and “offline” you must provide a valid user_instrument_vault_id.

Returns a list of checkout_settings.

Parameters

Name Type Required Description
checkout_settings.country_code string Yes The country code for the checkout settings object
checkout_settings.currency_code string Yes The currency code for the checkout settings object
checkout_settings.checkout_method string Yes The checkout method for the checkout settings object
checkout_settings.user_instrument_vault_id string No The vault ID for the user instrument if the checkout method requires one
checkout_settings.offline_settings objectlist No

A list of additional settings for the offline checkout method, with each offline setting being in the format {"payment_method": "CASH"|"CHECK"|"INVOICE", "instructions": "Optional instructions"}. Required if the checkout_method is “offline.” Example:

[
    {
      "payment_method": "CASH"
    },
    {
      "payment_method": "CHECK",
      "instructions": "Make checks payable to ABC corporation"
    },
    ...
]
paypal_email string No For the “paypal” checkout method, you can optionally specify a PayPal account email address instead of a user instrument vault ID, and a matching user instrument will be found or a new user instrument created with that email address and used to create the checkout settings.

Errors

  • DUPLICATE: You have attempted to create a checkout settings object for which this user already has an exact duplicate checkout settings object.
  • ERROR_USER_INSTRUMENT_VERIFICATION: The paypal_email address you specified is not associated with a valid PayPal account.

Argument Errors

  • checkout_settings.country_code - MISSING: You did not specify a value for this field.
  • checkout_settings.country_code - UNKNOWN: You passed an invalid value for this field.
  • checkout_settings.currency_code - MISSING: You did not specify a value for this field. It must be a valid ISO 4217 3-character currency code.
  • checkout_settings.currency_code - UNKNOWN: You passed an invalid value for this field. It must be a valid ISO 3166 alpha-2 country code.
  • checkout_settings.checkout_method - UNSUPPORTED: The value you supplied for this field is not supported for the given country and currency combination.
  • checkout_settings.checkout_method - MISSING: You did not specify a value for this field.
  • checkout_settings.checkout_method - UNKNOWN: You passed an invalid value for this field. It must be one of eventbrite, paypal, authnet, or offline.
  • checkout_settings.offline_settings - MISSING: You did not specify a value for this field, but a value is required when the checkout_method is offline.
  • checkout_settings.offline_settings - PROHIBITED: You are only allowed to specify this field when the checkout_method is offline.
  • checkout_settings.offline_settings.[index - value].payment_method MISSING: You did not specify a value for this field.
  • checkout_settings.offline_settings.[index - value].payment_method UNKNOWN: You passed an invalid value for this field. It must be one of CASH, CHECK, or INVOICE.
  • checkout_settings.user_instrument_vault_id - MISSING: You did not specify a value for this field. If checkout_method is paypal, either this field or paypal_email is required. If checkout_method is authnet, this field is always required.
  • checkout_settings.user_instrument_vault_id - NOT_ALLOWED: You are not allowed to use this user instrument for this event.
  • checkout_settings.user_instrument_vault_id - NOT_AUTHORIZED: You are not authorized to use this user instrument.
  • checkout_settings.user_instrument_vault_id - PROHIBITED: You are not allowed to specify this field unless checkout_method is paypal or authnet.
  • checkout_settings.user_instrument_vault_id - UNSUPPORTED_USER_INSTRUMENT_TYPE: If the checkout_method is paypal, the user instrument you specify must be a PayPal user instrument. If the checkout_method is authnet, the user instrument you specify must be an Authnet user instrument.
  • paypal_email - PROHIBITED: You are only allowed to specify this field if checkout_method is paypal, and only if you do not supply a user_instrument_vault_id.

GET /checkout_settings/:checkout_settings_id/

Get a specific checkout_settings object by ID

Parameters

Takes no parameters

Errors

No endpoint-specific errors

GET /events/:event_id/checkout_settings/

Gets and returns a list of checkout_settings associated with a given event by its event_id.

Parameters

Takes no parameters

Errors

  • MISSING_EVENT_COUNTRY_CURRENCY: A problem has occurred with this event’s payment country or currency. Please report this to customer support, along with the event ID.
  • MISSING_PAYMENT_OPTIONS: A problem has occurred with this event’s checkout settings. Please report this to customer support, along with the event ID.

POST /events/:event_id/checkout_settings/

Associate a single or set of checkout_settings with a given event by its event_id. This does not add more checkout settings to the event, but instead replaces all checkout settings for the event with the one(s) submitted. The JSON post body is a string list of the checkout_settings IDs you want to associate.

Parameters

Name Type Required Description
checkout_settings_ids list No A list of IDs for checkout settings that should be linked to the event. In the format: 1234,5678,9012

Errors

  • CANNOT_CHANGE_EVENT_CHECKOUT_METHOD: You cannot change, add, or remove the checkout method for an event that already has paid ticket sales.
  • CANNOT_CHANGE_EVENT_CURRENCY: You cannot change the payment currency for an event that already has paid ticket sales.
  • CANNOT_CHANGE_EVENT_PAYMENT_COUNTRY: In most circumstances, you cannot change the payment country for an event that already has paid ticket sales. The following exceptions exist: If the currency is USD, you can change the payment country between CA and US after paid ticket sales. If the currency is EUR, you can change the payment country between AT, BE, DE, ES, FR, FI, GB, GR, IE, IT, NL, and PT after paid ticket sales.
  • CONCURRENT_WRITE: Another request is already modifying the checkout settings for this event at this time.

Argument Errors

  • event_id - CANNOT_CHANGE_CHILD_EVENT_CHECKOUT_SETTINGS: You can not change checkout settings on a series child event; please use the series parent ID instead.
  • checkout_settings_ids - DUPLICATE: You cannot link the same checkout settings ID to an event multiple times.
  • checkout_settings_ids - INVALID: One or more of the checkout settings you are attempting to link to the event do not exist with the given IDs.
  • checkout_settings_ids - MUTUALLY_EXCLUSIVE_CHECKOUT_METHODS: The eventbrite, paypal, and authnet checkout methods are mutually exclusive; you cannot link any two checkout settings with two of these checkout methods to an event.
  • checkout_settings_ids.[id - value].checkout_method DUPLICATE: You cannot link multiple checkout settings with the same checkout method to an event. The [id value] indicates the first duplicate encountered.
  • checkout_settings_ids.[id - value].checkout_method UNSUPPORTED_CHECKOUT_METHOD: One or more of the checkout settings you are attempting to link to this event has a deprecated checkout method that is no longer supported. The [id value] indicates the first checkout setting with a deprecated checkout method.
  • checkout_settings_ids.[id - value].country_code CHECKOUT_SETTINGS_HAVE_DIFFERENT_COUNTRIES: You cannot assign more than one checkout settings object to an event unless they all have the same country. The [id value] indicates the first checkout setting with a differing country code from the others.
  • checkout_settings_ids.[id - value].country_code CHECKOUT_SETTINGS_HAVE_DIFFERENT_CURRENCIES: You cannot assign more than one checkout settings object to an event unless they all have the same currency. The [id value] indicates the first checkout setting with a differing currency code from the others.

GET /events/:event_id/payout_settings/

Gets and returns the payout_settings (user instrument ID) associated with a given event by its event_id.

Parameters

Takes no parameters

Errors

  • MISSING_PAYMENT_OPTIONS: A problem has occurred with this event’s payout settings. Please report this to customer support, along with the event ID.

POST /events/:event_id/payout_settings/

Associate a payout user instrument ID with a given event, or clear the association by passing a null value for the user instrument ID.

Parameters

Name Type Required Description
payout_settings.user_instrument_vault_id string No The vault ID for the user instrument to which payouts are sent

Errors

  • CONCURRENT_WRITE: Another request is already modifying the payout settings for this event at this time.
  • TRANSACTION_CAPABILITIES_ERROR: A problem has occurred while validating the user instrument. Please report this to full errorto customer support, along with the event ID.
  • UNSUPPORTED_PAYOUT: A problem has occurred while validating the user instrument. Please report this to full errorto customer support, along with the event ID.
  • USER_INSTRUMENT_ERROR: A problem has occurred while validating the user instrument. Please report this to full errorto customer support, along with the event ID.

Argument Errors

  • event_id - CANNOT_CHANGE_CHILD_EVENT_PAYOUT_SETTINGS: You can not change payout settings on a series child event; please use the series parent ID instead.
  • payout_settings.user_instrument_vault_id - INVALID:: This event is not permitted to have payout information, but you specified a non-null payout user instrument ID. Currently, only events with an eventbrite checkout settings checkout method require payout information.
  • payout_settings.user_instrument_vault_id - MISSING: This event requires payout information, but you did not specify the required payout user instrument ID. Currently, only events with an eventbrite checkout settings checkout method require payout information.
  • payout_settings.user_instrument_vault_id - NOT_ALLOWED: You are not allowed to use this payout instrument for this event.
  • payout_settings.user_instrument_vault_id - NOT_AUTHORIZED: You are not authorized to use this user instrument.
  • payout_settings.user_instrument_vault_id - UNSUPPORTED_DESTINATION_INSTRUMENT: This user instrument type is not supported for paying out this event.