Due to PCI compliant reasons we're going to turn off support for TLS v1.0 on all of our servers.
Please check/update you API implementations to support TLS v1.2 until 29.06.2018

REST API Payments

From XING Events Developer Documentation
Jump to: navigation, search

Object type: payment

This page contains information about all properties and methods regarding payments.

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 internal id of this object.
identifier
String
R--
The identifier of the payment.
lastModified Date R--
When the payment was modified the last time.
creationTime
Date
R--
When the payment was created.
buyerId
Integer
R--
The internal id of the buyer associated with the payment.
eventId Integer R--
The id of the associated event.
startDate Date R--
TODO
discountCode String R--
The discount code used in the payment.
amount Money R--
The amount to be paid.
applicationData String R--
The application data passed through an integrated iframe. Click here for detailed information
status String R--
Status of payment. Details
type String R--
Type of payment. Details
numTickets Integer R--
The number of tickets associated with the payment.
userData Array of UserData R--
This array holds user data objects. User data objects hold additional values to the payment.

Objects

Objects inside an payment, nested objects can be accessed through URLs like /api/payment/<id>/<object>. For example /api/payment/345543/address/buyer.

Name
Description
address/buyer Detailed information about the buyer address.
address/shipment Detailed information about the shipment address.

Methods

Read

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

Payment Status

The status property indicates the current status of the payment. Possible values are:

Payment Status
Description
authorized
TODO
cancelled
TODO
new
TODO
paid
TODO
disbursed
TODO


Payment Type

The type property indicates the way the payment will be / was paid. Possible values are:

Payment Type
Description
directdebit
TODO
creditcard
TODO
invoice
TODO
prepayment
TODO
paypal
TODO