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.xmoney.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

List all transactions

Request

Retrieve a list of transactions, optionally filtered by various criteria.

Query

orderIdinteger

Filter by order ID.

Example: orderId=123

customerIdinteger

Filter by customer ID.

Example: customerId=123

emailstring

Filter by customer email address.

Example: email=johndoe@example.com

transactionMethodstring

Filter by transaction method.

Enum"card""wallet""transfer"

Example: transactionMethod=card

currencystring

Filter by currency. Use ISO 4217 alpha codes.

Example: currency=USD

amountFromnumber(float)

Filter for transactions with an amount greater than or equal to this value.

Example: amountFrom=5

amountTonumber(float)

Filter for transactions with an amount less than or equal to this value.

Example: amountTo=10

transactionTypestring

Filter by transaction type.

Enum"deposit""refund""credit""chargeback""representment"

Example: transactionType=deposit

transactionStatusArray of strings

Filter by transaction status. Multiple statuses can be selected.

Items Enum"complete-ok""cancel-ok""refund-ok""void-ok""charge-back""complete-failed""in-progress""3d-pending"

Example: transactionStatus=complete-ok

dateTypestring

Specifies which date field to use for createdAtFrom and createdAtTo filtering.

Default "creation"

Enum"creation""approval""refund""cancellation""charge-back"

Example: dateType=refund

createdAtFromstring(date-time)

Filter for transactions with a date (specified by dateType) greater than or equal to this value. Use ISO 8601 format.

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

createdAtTostring(date-time)

Filter for transactions with a date (specified by dateType) less than or equal to this value. Use ISO 8601 format.

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

sourceArray of strings

Filter by transaction source. Multiple sources can be selected.

Items Enum"service-call""re-bill""re-bill-micro""card-change"

Example: source=service-call

cardTypestring

Filter by card type. (Only applicable if transactionMethod is card).

Enum"visa""mastercard""maestro"

Example: cardType=visa

cardNumberstring

Filter by masked card number. Supports filtering by:

Bin (first 1-6 digits, e.g., 401288* or 4012*)
Last 1-4 digits (e.g., *1881 or *81)
Bin and last digits (e.g., 401288******1881 or 4012******81).

(Only applicable if transactionMethod is card).

Example: cardNumber=401288*

countrystring

Filter by customer country code. Use ISO 3166-1 alpha-2 codes. (Only applicable if transactionMethod is card).

Example: country=US

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/transaction?amountFrom=5&amountTo=10&cardNumber=401288*&cardType=visa&country=US&createdAtFrom=2025-01-31T14%3A05%3A40%2B00%3A00&createdAtTo=2025-01-31T14%3A05%3A40%2B00%3A00&currency=USD&customerId=123&dateType=refund&email=johndoe%40example.com&orderId=123&page=1&perPage=100&reverseSorting=0&source=service-call&transactionMethod=card&transactionStatus=complete-ok&transactionType=deposit' \
  -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 transaction

Request

Retrieve a specific transaction by its ID.

Path

idintegerrequired

ID of the transaction to operate on.

Example: 123

curl -i -X GET \
  https://docs.xmoney.com/_mock/api/reference/transaction/123 \
  -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": 0,
    "siteId": 0,
    "orderId": 0,
    "customerId": 0,
    "customerData": { … },
    "transactionType": "deposit",
    "transactionMethod": "card",
    "transactionStatus": "complete-ok",
    "ip": "192.168.0.1",
    "amount": "string",
    "currency": "string",
    "amountInEur": "string",
    "description": "string",
    "customerCountry": "string",
    "creationDate": "2019-08-24T14:15:22Z",
    "creationTimestamp": 0,
    "transactionSource": "service-call",
    "cardProviderId": 0,
    "cardProvider": "string",
    "cardProviderName": "string",
    "cardHolderName": "string",
    "cardHolderCountry": "string",
    "cardHolderState": "string",
    "cardType": "visa",
    "cardNumber": "string",
    "cardExpiryDate": "string",
    "email": "user@example.com",
    "cardId": 0,
    "cardStatus": "active",
    "backUrl": "http://example.com",
    "cardDescriptor": "string",
    "externalCustomData": "string",
    "fraudScore": 0,
    "transactionOption": "string",
    "splitStatus": "string",
    "relatedTransactionIds": [ … ]
  }
}

Capture a transaction

Request

Capture a transaction that has been authorized but not yet captured.

Path

idintegerrequired

ID of the transaction to operate on.

Example: 123

Bodyapplication/x-www-form-urlencodedrequired

amountnumber(float)required

Amount to capture.

curl -i -X PUT \
  https://docs.xmoney.com/_mock/api/reference/transaction/123 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d amount=10

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"
}

Refund a transaction

Request

Initiate a refund for a transaction.

Path

idintegerrequired

ID of the transaction to operate on.

Example: 123

Bodyapplication/x-www-form-urlencodedrequired

reasonstring

Reason for refund.

Enum"fraud-confirm""highly-suspicious""duplicated-transaction""customer-demand""test-transaction""card-expired"

messagestring

Additional details about the refund.

amountnumber(float)

Amount to be refunded. If not provided, the full transaction amount will be refunded.

curl -i -X DELETE \
  https://docs.xmoney.com/_mock/api/reference/transaction/123 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d reason=customer-demand \
  -d 'message=Customer requested refund.' \
  -d amount=10

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"
}

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

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

List all transactions

Request

Responses

Was this helpful?

Retrieve a transaction

Request

Responses

Was this helpful?

Capture a transaction

Request

Responses

Was this helpful?

Refund a transaction

Request

Responses

Was this helpful?

Customer

Card