xMoney API Reference (1.0)

This documentation provides a comprehensive guide to xMoney's REST API, enabling you to seamlessly authenticate, make requests, and retrieve data. Our API accepts form-encoded request bodies and returns responses in JSON format for easy integration with your applications.

Find guides and examples on how to integrate xMoney.

Servers

Development

https://docs.xmoney.com/_mock/api/reference/

Staging

https://api-stage.twispay.com/

Order

This API resource manages orders, enabling creation, retrieval, and cancellation. This facilitates payment processing within the order management flow. It also supports management of recurring orders, including cancellation and rebilling.

Operations

Transaction

This API resource allows you to manage transactions processed through xMoney. Key functionalities include retrieving lists and details of transactions, capturing funds for authorized payments, and issuing refunds.

Operations

Customer

Use this API resource to manage your customers. You can create customers for payments, retrieve and update their information, and delete them (which cancels all mandates and subscriptions).

Operations

Create a customer

Request

Create a new customer object for processing payments.

Bodyapplication/x-www-form-urlencodedrequired

identifierstring<= 92 characters^[0-9a-zA-Z_@.-]{1,92}$required

External identifier for the customer.

emailstring(email)required

Customer's email address.

siteIdinteger

Unique identifier of your site profile. Mandatory if more than one site is configured.

firstNamestring

Customer's first name.

lastNamestring

Customer's last name.

countrystring

A two-character ISO 3166-1 alpha-2 country code.

Example: "US"

statestring

A two-character ISO 3166-2:US state code.

Example: "NY"

citystring

Customer's city of residence.

zipCodestring

Zip code. See Postal code definition.

addressstring

Customer's street address.

phonestring

Customer's phone number.

curl -i -X POST \
  https://docs.xmoney.com/_mock/api/reference/customer \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d identifier=customer-123 \
  -d email=johndoe@myshop.com \
  -d firstName=John \
  -d lastName=Doe \
  -d country=US \
  -d state=NY \
  -d 'city=New York' \
  -d zipCode=10001

Responses

Created

Bodyapplication/json

codeinteger

HTTP status code of the response.

Example: 200

messagestring

HTTP message of the response.

Example: "Success"

dataobject

Response

application/json

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 0
  }
}

List all customers

Request

Use this to fetch a list of your customers.

Query

identifierstring

Customer identifier provided in the create request.

emailstring

Customer email address.

countrystring

Filter by country code.

createdAtFromstring(date-time)

Filter by creation date bigger than this. Use ISO 8601 date, time and timezone offset.

Example: createdAtFrom=2000-01-31T14:05:40+00:00

createdAtTostring(date-time)

Filter by creation date smaller than this. Use ISO 8601 date, time and timezone offset.

Example: createdAtTo=2000-01-31T14:05:40+00:00

pageinteger

Page number.

Default 1

perPageinteger

Number of items per page.

Default 100

reverseSortinginteger

Sort order: 0 (oldest to newest), 1 (newest to oldest).

Default 1

Enum01

curl -i -X GET \
  'https://docs.xmoney.com/_mock/api/reference/customer?country=string&createdAtFrom=2000-01-31T14%3A05%3A40%2B00%3A00&createdAtTo=2000-01-31T14%3A05%3A40%2B00%3A00&email=string&identifier=string&page=1&perPage=100&reverseSorting=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

codeinteger

HTTP status code of the response.

Example: 200

messagestring

HTTP message of the response.

Example: "Success"

paginationobject

dataArray of objects

Response

application/json

{
  "code": 200,
  "message": "Success",
  "pagination": {
    "currentPageNumber": 1,
    "totalItemCount": 0,
    "itemCountPerPage": 100,
    "currentItemCount": 0,
    "pageCount": 0
  },
  "data": [
    { … }
  ]
}

Retrieve a customer

Request

Retrieve a customer by its ID.

Path

idintegerrequired

The ID of the customer to operate on.

curl -i -X GET \
  'https://docs.xmoney.com/_mock/api/reference/customer/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

codeinteger

HTTP status code of the response.

Example: 200

messagestring

HTTP message of the response.

Example: "Success"

dataobject

Response

application/json

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 123,
    "siteId": 123,
    "identifier": "customer-123",
    "firstName": "John",
    "lastName": "Doe",
    "country": "US",
    "state": "NY",
    "city": "New York",
    "zipCode": "10001",
    "address": "123 Main St",
    "phone": "+1 555 555 5555",
    "email": "user@example.com",
    "creationDate": "2020-05-18T00:00:00+00:00",
    "creationTimestamp": 1589788800
  }
}

Update a customer

Request

Use this endpoint to update your customer's details.

Path

idintegerrequired

The ID of the customer to operate on.

Bodyapplication/x-www-form-urlencodedrequired

identifierstring

External identifier. Allowed characters 0-9 a-z/A-z - _ . @ space and a max of 92 characters

emailstring

Email address.

firstNamestring

First name.

lastNamestring

Last name.

addressstring

Address.

citystring

City.

countrystring

A two-character ISO 3166-1 alpha-2 country code.

Example: "US"

statestring

A two-character ISO 3166-2:US state code.

Example: "NY"

zipCodestring

Zip code. See Postal code definition.

phonestring

Phone number.

curl -i -X PUT \
  'https://docs.xmoney.com/_mock/api/reference/customer/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d identifier=customer-1234 \
  -d email=customer@example.com \
  -d firstName=Jane \
  -d lastName=Doe

Responses

Success

Bodyapplication/json

codeinteger

HTTP status code of the response.

Example: 200

messagestring

HTTP message of the response.

Example: "Success"

dataobject

Response

application/json

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 123
  }
}

Delete a customer

Request

Permanently deletes a customer. All mandates and subscriptions created for this customer will be canceled as well.

Path

idintegerrequired

The ID of the customer to operate on.

curl -i -X DELETE \
  'https://docs.xmoney.com/_mock/api/reference/customer/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json

codeinteger

HTTP status code of the response.

Example: 200

messagestring

HTTP message of the response.

Example: "Success"

Response

application/json

{
  "code": 200,
  "message": "Success"
}

Card

This endpoint allows you to manage customer cards, including retrieving lists and details of cards, and deleting cards.

Operations

xMoney API Reference (1.0)

Order

Transaction

Customer

Create a customer

Request

Responses

Was this helpful?

List all customers

Request

Responses

Was this helpful?

Retrieve a customer

Request

Responses

Was this helpful?

Update a customer

Request

Responses

Was this helpful?

Delete a customer

Request

Responses

Was this helpful?

Card