Swipelux
Transfer API

Get all transfers

Retrieve all transfers

GET
/v1/transfers

Authorization

X-API-Key<token>

In: header

Response Body

The list of transfers

responseRequiredarray<object>
export type Response = {
  /**
   * The unique ID of the transfer
   */
  id: string;
  /**
   * The current state of the transfer
   */
  state: "awaiting_funds" | "pending" | "completed" | "failed";
  /**
   * The ID of the customer that you're moving funds on behalf of
   */
  onBehalfOf: string;
  /**
   * The source amount of the transfer
   */
  amount: string;
  /**
   * Source of the transfer
   */
  source: {
    /**
     * The payment rail to use for the transfer
     */
    paymentRail?: "polygon" | "card" | "wire" | "apple_pay";
    /**
     * The source currency code
     */
    currency: string;
  };
  /**
   * Destination of the transfer. Only either a customer ID or a crypto wallet address can be provided at once.
   */
  destination: {
    /**
     * The destination currency
     */
    currency: string;
    /**
     * The customer ID to which we'll send the funds to
     */
    customerId?: string;
    /**
     * The crypto wallet address to which we'll send the funds to
     */
    walletAddress?: string;
  };
  /**
   * Instructions for the source deposit (if applicable)
   */
  sourceInstructions?: {
    /**
     * The signed URL for user to complete the payment (applicable for on-ramp transfers)
     */
    signedUrl: string;
  };
  /**
   * The date and time the transfer was created
   */
  createdAt: string;
  /**
   * The date and time the transfer was last updated
   */
  updatedAt: string;
}[];
 
curl -X GET "https://wallet.swipelux.com/v1/transfers" \
  -H "X-API-Key: <token>"
[
  {
    "id": "string",
    "state": "awaiting_funds",
    "onBehalfOf": "string",
    "amount": "string",
    "source": {
      "paymentRail": "polygon",
      "currency": "string"
    },
    "destination": {
      "currency": "string",
      "customerId": "string",
      "walletAddress": "string"
    },
    "sourceInstructions": {
      "signedUrl": "http://example.com"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]