REST API PaymentTypes

From XING Events Developer Documentation
Jump to: navigation, search

Object type: paymentType
This object used to organize what payment types are allowed for the event. If the host allows a PaymentType, an object with the associated "type"-attribute is created. When the type is later removed (on the homepage) and no tickets were sold with this type yet, the whole object is deleted. If tickets were already sold for the type, the "active"-attribute will be set to false. With the REST-API you cannot delete a TicketType. The delete-method will set "active" to false.

Properties

PaymentType objects provide the following properties.

Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Property
Type
Attributes Description

id
Integer
R--
The id of the PaymentType.
type
String
R-C
The type of the PaymentType.
Must be one of the following:
required
PAYMENT_TYPE_ELV Direct debit
PAYMENT_TYPE_CC Credit card
PAYMENT_TYPE_INVOICE Invoice payment
PAYMENT_TYPE_PREPAYMENT Pre-payment via bank transfer
PAYMENT_TYPE_PP Paypal
PAYMENT_TYPE_SOFORT Sofortüberweisung
PAYMENT_TYPE_ONLOCATION Cash payment with EasyEntry
PAYMENT_TYPE_ONLOCATION_INVOICE Invoice payment with EasyEntry
PAYMENT_TYPE_ONLOCATION_MPOS Credit card payment with EasyEntry using our card reader
PAYMENT_TYPE_DIRECT Custom payment option (direct payment to organizer)
active
Boolean
RWC
Is this PaymentType activated?

Methods

Enumerate Payment Types

See Enumerate Payment Types.


Read

Call GET /api/paymentType/<id>
Description This request will return the PaymentType object with the specified internal id. The response contains all properties marked with R.
Response {"paymentType":{"id": ...}, "success":true}.
Needed key type Any
Errors See General Errorcodes.

Create

Call POST /api/event/<id>/paymentType/create
Parameters All properties marked with C. type is required.
Description This request will register a PaymentType to the specified event and will return the internal id. The internal id can be used for read or update requests.
Response {"id":<internal id>,"success":true}.
Needed key type Administrator, Editor
Errors com.amiando.api.rest.paymentType.PaymentTypeNotAllowed

com.amiando.api.rest.paymentType.PaymentTypeAlreadyExists
See General Errorcodes.

Update

Call POST /api/paymentType/<id>
Parameters All properties marked with W.
Description This request will update the properties of the PaymentType with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Needed key type Administrator, Editor
Errors See General Errorcodes.


Delete

Call DELETE /api/paymentType/<id>
Description This request will not delete but deactivate the PaymentType with the specified internal id. The response is always deleted:false.
Response {"deleted":false, "success":true}.
Needed key type Administrator, Editor
Errors See General Errorcodes.
REST API Contents
Getting Started Get your API key Overview Formats Errors
Data Types Event Participant Payment Ticket
Ticket Categories ProductDefinition Products CodeDefinition
TicketShop Addresses Ticket Types Payment Types
BankAccount UserDataDefinition UserData User
ApiKey
Data Synchronization Sync Interface