API Documentation

• API Methods
• Authentication
• API Errors

API Method /payment_update

This method creates or updates the payment options for this event. Only the fields passed as arguments will be modified. It returns the list of active method of payment.

Arguments

authentication

This method controls access via required user authentication.

event_id integer

The event ID.

accept_paypal integer optional

Accept PayPal payments (1 or 0).

paypal_email string

Your PayPal email. Defaults to the user email address if not provided.

accept_googleinteger optional

Accept Google Checkout payments (1 or 0).

google_merchant_id string

Google Checkout Merchant ID. Required if accept_google is 1.

google_merchant_key string

Google Checkout Merchant Key. Required if accept_google is 1.

accept_checkinteger optional

Accept "Pay by Check" payments (1 or 0).

instructions_checkstring optional

Instructions to attendees who want to pay by check.

accept_cashinteger optional

Accept "Pay with Cash" payments (1 or 0).

instructions_cashstring optional

Instructions to attendees who want to pay with cash.

accept_invoiceinteger optional

Accept "Send an Invoice" payments (1 or 0).

instructions_invoicestring optional

Instructions to attendees who need to be sent an invoice.

Example Request

Output Parameters

This method returns XML with the following structure:

id integer

Internal event id used.

method string

The list of active payment methods "created or Updated".

status string

Processing status.

message string

Processing message.

Example XML Response

<?xml version="1.0" encoding="utf-8" ?>
<process>
	<id>123456789</id>
	<message>payment_udate : create/update</message>
	<method>PAYPAL-GOOGLE</method>
	<status>ok</status>
</process>

Error Codes

This method may return these errors in an error document:

Authentication Error

The specified user was not found or the login credentials didn't match.

Not Found

No such event [1234567].

Method error

Please select at least one method of payment (PayPal,Google or Alternative).

PayPal error

Invalid value for accept_PayPal method (0 or 1).

Please provide a valid Paypal email.

Google error

Invalid value for accept_Google method (0 or 1).

Please provide a valid Google merchant ID and Key.

To use Google Checkout you need to enter a 10 or 15 digit Google Checkout Merchant ID.

To use Google Checkout you need to enter a 22 character Google Checkout Merchant Key.

Check error

Invalid value for "Pay by Check" method (0 or 1).

Cash error

Invalid value for Cash method (0 or 1).

Invoice error

Invalid value for Invoice method (0 or 1).