Introduction

The xMoney API provides a comprehensive and secure way to integrate payment processing into your applications. This RESTful API allows you to seamlessly manage orders, transactions, customers, and card details.

Key features

  • Manage the entire payment lifecycle:

    • Create and manage orders
    • Process recurring billing
    • Handle transactions
    • Capture authorized payments
    • Issue refunds
  • Streamline customer management:

    • Create, retrieve, update, and manage customer information
    • Manage customer mandates and subscriptions
  • Securely handle card details:

    • Manage customer cards
    • Retrieve card details
    • Securely delete cards
  • Seamless integration:

    • Standard HTTPS connections with TLS 1.2 or higher
    • API key authentication
    • Easy integration with your existing systems

Request format

The xMoney API expects requests to be submitted with a Content-Type of application/x-www-form-urlencoded. This means that data should be encoded in the URL-encoded format, where key-value pairs are separated by ampersands (&) and keys and values are encoded using percent-encoding (e.g., spaces are replaced by %20).

Example request

curl -X POST \
  https://api-stage.twispay.com/customer \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d email=johndoe@example.com \
  -d identifier=my-unique-id

Response format

The API will return responses in JSON (JavaScript Object Notation) format. Responses will typically include a status code indicating the success or failure of the request, along with any relevant data.

Example response

{
    "code": 201,
    "message": "Created",
    "data": {
        "id": unique-id
    }
}