# xMoney API Reference

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.

Version: 1.0

## Servers

Staging
```
https://api-stage.xmoney.com
```

Office Staging
```
https://office-api-stage.xmoney.com
```

## Security

### Bearer

API Private Key

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [xMoney API Reference](https://docs.xmoney.com/_bundle/api/reference.yaml)

## Order

 - [POST /order](https://docs.xmoney.com/api/reference/order/create-an-order.md): This endpoint creates new orders, supporting both one-time purchases and recurring subscriptions.
 - [GET /order](https://docs.xmoney.com/api/reference/order/list-all-orders.md): Retrieve a list of orders, optionally filtered by various criteria.
 - [GET /order/{id}](https://docs.xmoney.com/api/reference/order/retrieve-an-order.md): Retrieve a specific order by its ID.
 - [DELETE /order/{id}](https://docs.xmoney.com/api/reference/order/cancel-a-recurring-order.md): An open order may be canceled if it does not have any payments yet.
 - [PATCH /order-rebill/{id}](https://docs.xmoney.com/api/reference/order/initiate-recurring-order-transaction.md): Manually bills a customer for their managed order. This endpoint allows merchants to control when managed order payments are processed.
## Transaction

 - [GET /transaction](https://docs.xmoney.com/api/reference/transaction/list-all-transactions.md): Retrieve a list of transactions, optionally filtered by various criteria.
 - [GET /transaction/{id}](https://docs.xmoney.com/api/reference/transaction/retrieve-a-transaction.md): Retrieve a specific transaction by its ID.
 - [PUT /transaction/{id}](https://docs.xmoney.com/api/reference/transaction/capture-a-transaction.md): Capture a transaction that has been authorized but not yet captured.
 - [DELETE /transaction/{id}](https://docs.xmoney.com/api/reference/transaction/refund-a-transaction.md): Initiate a refund for a transaction.
## Customer

 - [POST /customer](https://docs.xmoney.com/api/reference/customer/create-a-customer.md): Create a new customer object for processing payments.
 - [GET /customer](https://docs.xmoney.com/api/reference/customer/list-all-customers.md): Use this to fetch a list of your customers.
 - [GET /customer/{id}](https://docs.xmoney.com/api/reference/customer/retrieve-a-customer.md): Retrieve a customer by its ID.
 - [PUT /customer/{id}](https://docs.xmoney.com/api/reference/customer/update-a-customer.md): Use this endpoint to update your customer's details.
 - [DELETE /customer/{id}](https://docs.xmoney.com/api/reference/customer/delete-a-customer.md): Permanently deletes a customer. All mandates and subscriptions created for this customer will be canceled as well.
## Card

 - [GET /card](https://docs.xmoney.com/api/reference/card/list-all-cards.md): Retrieve a list of cards for a specific customer.
 - [GET /card/{id}](https://docs.xmoney.com/api/reference/card/retrieve-a-card.md): Retrieve details of a specific card.
 - [DELETE /card/{id}](https://docs.xmoney.com/api/reference/card/delete-a-card.md): Delete a specific card.
## Payment Links

 - [GET /payment-link](https://docs.xmoney.com/api/reference/payment-links/getpaymentlinklist.md)
 - [POST /payment-link](https://docs.xmoney.com/api/reference/payment-links/createpaymentlink.md)
 - [GET /payment-link/{hash}](https://docs.xmoney.com/api/reference/payment-links/getpaymentlinkbyhash.md)
 - [PUT /payment-link/{hash}](https://docs.xmoney.com/api/reference/payment-links/updatepaymentlinkbyhash.md)
 - [DELETE /payment-link/{hash}](https://docs.xmoney.com/api/reference/payment-links/deletepaymentlink.md)