Card

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

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

List all cards

Request

Retrieve a list of cards for a specific customer.

Query
customerIdintegerrequired

ID of the customer whose cards to retrieve.

Example: customerId=123
orderIdinteger

ID of the order associated with the cards.

Example: orderId=123
hasTokenstring

Filter cards based on tokenization status.

Enum"yes""no"
Example: hasToken=yes
cardStatusstring

Filter cards based on their status. If omitted, only active cards are returned.

Enum"all""deleted"
Example: cardStatus=all
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/card?cardStatus=all&customerId=123&hasToken=yes&orderId=123&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 card

Request

Retrieve details of a specific card.

Path
idintegerrequired

ID of the card to operate on.

Example: 123
Query
customerIdintegerrequired

ID of the customer who owns the card.

Example: customerId=123
curl -i -X GET \
  'https://docs.xmoney.com/_mock/api/reference/card/123?customerId=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": 123,
    "customerId": 123,
    "type": "visa",
    "cardNumber": "424242*******1234",
    "expiryMonth": "12",
    "expiryYear": "2030",
    "nameOnCard": "John Doe",
    "cardHolderCountry": "US",
    "cardHolderState": "NY",
    "cardProvider": "romcard",
    "hasToken": false,
    "cardStatus": "active",
    "binInfo": { … }
  }
}

Delete a card

Request

Delete a specific card.

Path
idintegerrequired

ID of the card to operate on.

Example: 123
curl -i -X DELETE \
  https://docs.xmoney.com/_mock/api/reference/card/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"
Response
application/json
{
  "code": 200,
  "message": "Success"
}
Copyright © xMoney Inc. All rights reserved.