Swipelux Wallet API

https://platform.swipelux.com/api-reference
Admin
Swipelux Wallet API enables you to create customers, provision wallets, and initiate transfers...
Tokens:5,363
Snippets:16
Trust Score:7.5
Update:7 months ago
Show doc for...
Tokens:
Raw
### GET /v1/customers

Source: https://platform.swipelux.com/api-reference

Retrieve a paginated list of customers associated with the merchant account, with optional filtering by email, phone, or status.

```APIDOC
## GET /v1/customers

### Description
Retrieve all customers for a merchant with pagination support and optional filtering parameters.

### Method
GET

### Endpoint
https://platform.swipelux.com/v1/customers

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination (default: 1)
- **limit** (integer) - Optional - Number of results per page (default: 50, max: 100)
- **email** (string) - Optional - Filter by customer email address
- **phone** (string) - Optional - Filter by customer phone number
- **customerId** (string) - Optional - Filter by specific customer ID
- **type** (enum) - Optional - Filter by customer type (individual, business)
- **createdFrom** (string) - Optional - Filter customers created on or after this date (ISO 8601)
- **createdTo** (string) - Optional - Filter customers created on or before this date (ISO 8601)
- **search** (string) - Optional - Search by name, email, phone, or customer ID

### Request Example
```bash
curl https://platform.swipelux.com/v1/customers \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **customers** (array) - List of customer objects
- **pagination** (object) - Pagination metadata

#### Response Example
```json
{
  "customers": [
    {
      "id": "string",
      "type": "individual",
      "email": "hello@example.com",
      "status": "not_started",
      "balance": 1
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}
```
```

--------------------------------

### Get All Customers (Shell Curl)

Source: https://platform.swipelux.com/api-reference

Retrieves a list of all customers for a merchant, supporting pagination and filtering by email, phone, customer ID, type, creation date, and search terms. Requires an API key for authentication.

```shell
curl https://platform.swipelux.com/v1/customers \
  --header 'X-API-Key: YOUR_SECRET_TOKEN'
```

--------------------------------

### Get All Customers

Source: https://platform.swipelux.com/api-reference

Retrieves a list of all customers associated with your Swipelux account. Supports filtering by email, phone, customer ID, type, and creation date range.

```APIDOC
## GET /v1/customers

### Description
Retrieves a list of all customers. You can filter the results using various query parameters.

### Method
GET

### Endpoint
`/v1/customers`

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **limit** (integer) - Optional - The number of results to return per page.
- **email** (string) - Optional - Filter customers by email address.
- **phone** (string) - Optional - Filter customers by phone number.
- **customerId** (string) - Optional - Filter customers by their unique customer ID.
- **type** (string) - Optional - Filter customers by type ('individual' or 'business'). Defaults to 'individual'.
- **createdFrom** (string) - Optional - Filter customers created after this date (ISO 8601 format).
- **createdTo** (string) - Optional - Filter customers created before this date (ISO 8601 format).
- **search** (string) - Optional - A general search term to find customers.

### Request Example
`GET https://platform.swipelux.com/v1/customers?limit=10&email=test@example.com`

### Success Response (200)
- **customers** (array) - An array of customer objects.
  - **customerId** (string) - The unique identifier for the customer.
  - **email** (string) - The customer's email address.
  - **phone** (string) - The customer's phone number.
  - **type** (string) - The type of the customer ('individual' or 'business').
  - **createdAt** (string) - The timestamp when the customer was created.

### Response Example
```json
{
  "customers": [
    {
      "customerId": "cus_abc123",
      "email": "test@example.com",
      "phone": "+15551234567",
      "type": "individual",
      "createdAt": "2023-01-01T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Payout Quotes API

Source: https://platform.swipelux.com/api-reference

Provides functionality to get quotes before creating payouts, ensuring price transparency and rate locking for transactions.

```APIDOC
## Payout Quotes API

### Description
Get quotes before creating payouts. This API allows you to obtain exchange rates and fees upfront, providing price transparency and locking in rates for a short period.

### Why Use Quotes?
* **Price Transparency**: Show exact fees and exchange rates to users before they commit.
* **Rate Lock**: Lock in the exchange rate for 5 minutes.
* **Compliance**: Required for regulated offramp transactions.

### Supported Payout Types
| From | To | Description |
|---|---|---|
| `wal_xxx` | `wal_xxx` | Crypto-to-crypto (same chain) |
| `wal_xxx` | `acc_xxx` | Offramp to bank account |

### Example Flow
1. **Create Quote**: `POST /v1/payout/quote` - Get exchange rate and fees upfront.
2. **Execute Payout**: `POST /v1/payout` with `{ "quote": "quo_xxx" }`.

### Example Request & Response
```json
// Step 1: Create quote for offramp
POST /v1/payout/quote
{
  "from": { "id": "wal_xxx", "amount": 100 },
  "to": { "id": "acc_xxx", "currency": "EUR" }
}

// Response
{
  "id": "quo_xxx",
  "rate": "0.92",
  "fee": { "total": "1.50", "currency": "USD" },
  "destination_amount": "90.62"  // EUR after conversion and fees
}

// Step 2: Execute with quote
POST /v1/payout
{ "quote": "quo_xxx" }
```

### Operations
* `POST /v1/payout/quote`
* `POST /v1/payout`
```

--------------------------------

### Create individual customer via POST /v1/customers

Source: https://platform.swipelux.com/api-reference

Demonstrates how to create a new individual customer by sending a JSON payload to the Swipelux API. Requires a valid API key in the header and mandatory fields such as phone number in E.164 format and website URL.

```shell
curl https://platform.swipelux.com/v1/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_TOKEN' \
  --data '{
  "type": "individual",
  "firstName": "",
  "middleName": "",
  "lastName": "",
  "legalName": "",
  "website": "",
  "email": "",
  "phone": "",
  "metadata": {
    "additionalProperty": ""
  },
  "birthDate": "",
  "residentialAddress": {
    "streetLine1": "",
    "streetLine2": "",
    "city": "",
    "state": "",
    "postalCode": "",
    "country": ""
  },
  "identifyingInformation": [
    {
      "type": "drivers_license",
      "issuingCountry": "",
      "frontSideImage": "",
      "backSideImage": ""
    }
  ]
}'
```

--------------------------------

### POST /v1/customers

Source: https://platform.swipelux.com/api-reference

Creates a new individual customer. Required fields include website and phone number in E.164 format. For business customers, use POST /v1/customers/business.

```APIDOC
## POST /v1/customers

### Description
Create a new individual customer. Required fields: website, phone (E.164 format). For business customers, use POST /v1/customers/business instead.

### Method
POST

### Endpoint
/v1/customers

### Parameters
#### Request Body
- **phone** (string) - Required - The primary phone number of the customer in E.164 format (e.g., +1234567890). Pattern:  ^\+[0-9]{7,15}$
- **website** (string) - Required - The website URL of the customer. Min length: 1, Max length: 2048
- **birthDate** (string) - Optional - The date of birth of the customer in ISO 8601 format (YYYY-MM-DD)
- **email** (string) - Optional - The primary email address of the customer
- **firstName** (string) - Optional - The first name of the customer. Min length: 1, Max length: 100
- **identifyingInformation** (array object[]) - Optional - An array of identifying information for the customer
- **lastName** (string) - Optional - The last name of the customer. Min length: 1, Max length: 100
- **legalName** (string) - Optional - The legal name of the business (required when type is 'business'). Min length: 1, Max length: 1024
- **metadata** (object) - Optional - The provided metadata of the customer
- **middleName** (string) - Optional - The middle name of the customer. Min length: 1, Max length: 100
- **residentialAddress** (object) - Optional - The residential address of the customer
- **type** (string) - Optional - The type of customer: individual (default) or business. Enum: "individual", "business"

### Request Example
```json
{
  "type": "individual",
  "firstName": "",
  "middleName": "",
  "lastName": "",
  "legalName": "",
  "website": "",
  "email": "",
  "phone": "",
  "metadata": {
    "additionalProperty": ""
  },
  "birthDate": "",
  "residentialAddress": {
    "streetLine1": "",
    "streetLine2": "",
    "city": "",
    "state": "",
    "postalCode": "",
    "country": ""
  },
  "identifyingInformation": [
    {
      "type": "drivers_license",
      "issuingCountry": "",
      "frontSideImage": "",
      "backSideImage": ""
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the customer
- **type** (string) - The type of customer
- **firstName** (string) - The first name of the customer
- **middleName** (string) - The middle name of the customer
- **lastName** (string) - The last name of the customer
- **legalName** (string) - The legal name of the business
- **website** (string) - The website URL of the customer
- **email** (string) - The primary email address of the customer
- **phone** (string) - The primary phone number of the customer
- **birthDate** (string) - The date of birth of the customer
- **country** (string) - The country of the customer
- **status** (string) - The status of the customer
- **metadata** (object) - The provided metadata of the customer
- **walletAddresses** (array string) - A list of wallet addresses associated with the customer
- **balance** (number) - The current balance of the customer
- **createdAt** (string) - The timestamp when the customer was created
- **updatedAt** (string) - The timestamp when the customer was last updated

#### Response Example
```json
{
  "id": "string",
  "type": "individual",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "legalName": "string",
  "website": "string",
  "email": "hello@example.com",
  "phone": "string",
  "birthDate": "2026-03-19",
  "country": "string",
  "status": "not_started",
  "metadata": {
    "additionalProperty": "string"
  },
  "walletAddresses": [
    "string"
  ],
  "balance": 1,
  "createdAt": "string",
  "updatedAt": "string"
}
```
```

--------------------------------

### Execute payout quote flow

Source: https://platform.swipelux.com/api-reference

Illustrates the two-step process for payouts: first requesting a quote to lock in rates and fees, then executing the payout using the returned quote ID.

```json
// Step 1: Create quote for offramp
POST /v1/payout/quote
{
  "from": { "id": "wal_xxx", "amount": 100 },
  "to": { "id": "acc_xxx", "currency": "EUR" }
}

// Response
{
  "id": "quo_xxx",
  "rate": "0.92",
  "fee": { "total": "1.50", "currency": "USD" },
  "destination_amount": "90.62"  // EUR after conversion and fees
}

// Step 2: Execute with quote
POST /v1/payout
{ "quote": "quo_xxx" }
```

--------------------------------

### Webhooks

Source: https://platform.swipelux.com/api-reference

Configure webhook endpoints to receive real-time event notifications from the Swipelux platform.

```APIDOC
## Webhooks

### Description
Configure webhook endpoints for real-time event notifications.

### Webhook Signature
Verify webhooks using the `X-Webhook-Signature` header (HMAC-SHA256).

### Customer Events
(Details about specific customer events and their corresponding webhook payloads would typically be listed here.)
```

--------------------------------

### Webhooks Operations

Source: https://platform.swipelux.com/api-reference

Endpoints for managing webhook subscriptions, allowing you to receive real-time notifications for events.

```APIDOC
## Webhooks API

### GET /v1/webhooks

#### Description
Retrieves a list of all configured webhook subscriptions.

### PATCH /v1/webhooks

#### Description
Updates an existing webhook subscription. This endpoint allows modification of webhook URLs, event subscriptions, and other settings.
```

--------------------------------

### Transfer Lifecycle Webhooks

Source: https://platform.swipelux.com/api-reference

A collection of JSON schemas representing various states of a transfer lifecycle, including creation, updates, completion, failure, and partial funding.

```json
{
  "type": "transfer.created",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "pending"
  },
  "createdAt": 1704067200000
}
```

```json
{
  "type": "transfer.updated",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "processing"
  },
  "createdAt": 1704067200000
}
```

```json
{
  "type": "transfer.completed",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "completed"
  },
  "createdAt": 1704067200000
}
```

```json
{
  "type": "transfer.failed",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "failed"
  },
  "createdAt": 1704067200000
}
```

```json
{
  "type": "transfer.funded_partial",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "funded_partial"
  },
  "createdAt": 1704067200000
}
```

```json
{
  "type": "transfer.amount_adjusted",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "from": "100.00",
    "to": "95.50"
  },
  "createdAt": 1704067200000
}
```

--------------------------------

### Transfer Events

Source: https://platform.swipelux.com/api-reference

A collection of events related to the lifecycle of a transfer, including creation, updates, completion, failure, partial funding, and amount adjustments.

```APIDOC
## Transfer Events

### Event: transfer.created

#### Description
This event is triggered when a new transfer is created.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **state** (string) - The current state of the transfer (e.g., 'pending').

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.created",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "pending"
  },
  "createdAt": 1704067200000
}
```

### Event: transfer.updated

#### Description
This event is triggered when a transfer's details or state are updated.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **state** (string) - The updated state of the transfer (e.g., 'processing').

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.updated",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "processing"
  },
  "createdAt": 1704067200000
}
```

### Event: transfer.completed

#### Description
This event is triggered when a transfer has been successfully completed.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **state** (string) - The state of the transfer, which is 'completed'.

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.completed",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "completed"
  },
  "createdAt": 1704067200000
}
```

### Event: transfer.failed

#### Description
This event is triggered when a transfer has failed.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **state** (string) - The state of the transfer, which is 'failed'.

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.failed",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "failed"
  },
  "createdAt": 1704067200000
}
```

### Event: transfer.funded_partial

#### Description
This event is triggered when a transfer has been partially funded.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **state** (string) - The state of the transfer, which is 'funded_partial'.

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.funded_partial",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "state": "funded_partial"
  },
  "createdAt": 1704067200000
}
```

### Event: transfer.amount_adjusted

#### Description
This event is triggered when the amount of a transfer has been adjusted.

#### Data Fields
- **id** (string) - The unique identifier for the transfer.
- **onBehalfOf** (string) - The customer ID on whose behalf the transfer was initiated.
- **from** (string) - The previous amount of the transfer.
- **to** (string) - The new adjusted amount of the transfer.

#### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

#### Example Payload
```json
{
  "type": "transfer.amount_adjusted",
  "data": {
    "id": "tr_xyz789",
    "onBehalfOf": "cus_abc123",
    "from": "100.00",
    "to": "95.50"
  },
  "createdAt": 1704067200000
}
```
```

--------------------------------

### Customer Verification Changed Webhook

Source: https://platform.swipelux.com/api-reference

Represents the JSON payload sent when a customer's verification status changes. It includes the customer ID, type, and the transition between verification states.

```json
{
  "type": "customer.verification_changed",
  "data": {
    "customerId": "cus_abc123",
    "customerType": "individual",
    "verificationStatus": "approved",
    "previousStatus": "pending",
    "reason": null
  },
  "createdAt": 1704067200000
}
```

--------------------------------

### Customer Verification Changed Event

Source: https://platform.swipelux.com/api-reference

This event is triggered when a customer's verification status changes. It includes details about the customer, their type, the new status, the previous status, and any reason for the change.

```APIDOC
## Event: customer.verification_changed

### Description
This event is triggered when a customer's verification status changes. It includes details about the customer, their type, the new status, the previous status, and any reason for the change.

### Data Fields
- **customerId** (string) - The unique identifier for the customer.
- **customerType** (string) - The type of the customer ('individual' or 'business').
- **verificationStatus** (string) - The new verification status ('not_started', 'pending', 'approved', 'rejected').
- **previousStatus** (string) - The previous verification status.
- **reason** (string | null) - The reason for the status change, if any.

### Event Timestamp
- **createdAt** (integer) - The timestamp when the event occurred (in milliseconds).

### Example Payload
```json
{
  "type": "customer.verification_changed",
  "data": {
    "customerId": "cus_abc123",
    "customerType": "individual",
    "verificationStatus": "approved",
    "previousStatus": "pending",
    "reason": null
  },
  "createdAt": 1704067200000
}
```

### Possible Values
- **customerType**: `individual`, `business`
- **verificationStatus**:
  - For **individual** (KYC): `not_started`, `pending`, `approved`, `rejected`.
  - For **business** (KYB): `pending`, `approved`, `rejected` (businesses start with `pending` on creation).
```
Tokens:
Raw