Swipelux
Transfer API

Get a transfer by ID

Retrieve a transfer by ID

GET
/v1/transfers/{id}

Authorization

X-API-Key<token>

In: header

Path Parameters

idRequiredstring

The transfer ID

Response Body

The transfer object

idRequiredstring

The unique ID of the transfer

stateRequiredunknown

The current state of the transfer

Value in: "awaiting_funds" | "pending" | "in_progress" | "completed" | "failed"
fromRequiredobject

Transfer source details

toRequiredobject

Transfer destination details

urlstring

Payment link for fiat rails or blockchain explorer link for crypto rails

createdAtRequiredstring

The date and time the transfer was created

Format: "date-time"
updatedAtRequiredstring

The date and time the transfer was last updated

Format: "date-time"
hintsarray<object>

Helpful suggestions for next API calls

export interface Response {
  /**
   * The unique ID of the transfer
   */
  id: string;
  /**
   * The current state of the transfer
   */
  state: "awaiting_funds" | "pending" | "in_progress" | "completed" | "failed";
  /**
   * Transfer source details
   */
  from: {
    /**
     * Customer ID or wallet address
     */
    identifier: string;
    /**
     * Transfer amount
     */
    amount: string;
    /**
     * Payment rail used
     */
    rail: "polygon" | "card" | "wire" | "open_banking";
    /**
     * Currency code
     */
    currency: string;
  };
  /**
   * Transfer destination details
   */
  to: {
    /**
     * Destination wallet address
     */
    identifier: string;
  };
  /**
   * Payment link for fiat rails or blockchain explorer link for crypto rails
   */
  url?: string;
  /**
   * The date and time the transfer was created
   */
  createdAt: string;
  /**
   * The date and time the transfer was last updated
   */
  updatedAt: string;
  /**
   * Helpful suggestions for next API calls
   */
  hints?: {
    /**
     * Action description
     */
    description: string;
    /**
     * HTTP request details
     */
    request: {
      /**
       * HTTP method
       */
      method: string;
      /**
       * API endpoint URL
       */
      url: string;
      /**
       * Request body with placeholders
       */
      body?: {
        [k: string]: unknown;
      };
    };
  }[];
}
 
curl -X GET "https://wallet.swipelux.com/v1/transfers/string" \
  -H "X-API-Key: <token>"
{
  "id": "string",
  "state": "awaiting_funds",
  "from": {
    "identifier": "string",
    "amount": "string",
    "rail": "polygon",
    "currency": "string"
  },
  "to": {
    "identifier": "string"
  },
  "url": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "hints": [
    {
      "description": "string",
      "request": {
        "method": "string",
        "url": "string",
        "body": null
      }
    }
  ]
}