Swipelux
Transfer API

Create a new transfer

Create a new transfer

POST
/v1/transfers

Authorization

X-API-Key<token>

In: header

Request Body

application/jsonOptional
onBehalfOfRequiredstring

The ID of the customer that you're moving funds on behalf of

amountRequiredstring

The source amount of the transfer

Pattern: "^[+-]?(?:\\d*\\.)?\\d+$"
sourceRequiredobject

Source of the transfer

destinationRequiredobject

Destination of the transfer

Response Body

The transfer was created successfully

idRequiredstring

The unique ID of the transfer

stateRequiredunknown

The current state of the transfer

Value in: "awaiting_funds" | "pending" | "completed" | "failed"
onBehalfOfRequiredstring

The ID of the customer that you're moving funds on behalf of

amountRequiredstring

The source amount of the transfer

Pattern: "^[+-]?(?:\\d*\\.)?\\d+$"
sourceRequiredobject

Source of the transfer

destinationRequiredobject

Destination of the transfer

sourceInstructionsobject

Instructions for the source deposit (if applicable)

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"
export interface 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: "card" | "wire" | "apple_pay";
    /**
     * The source currency code
     */
    currency: string;
    /**
     * The wallet ID to which we'll send the funds from
     */
    walletId?: string;
  };
  /**
   * Destination of the transfer
   */
  destination: {
    /**
     * The destination currency
     */
    currency: string;
    /**
     * The wallet ID to which we'll send the funds to
     */
    walletId?: 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 POST "https://wallet.swipelux.com/v1/transfers" \
  -H "X-API-Key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "onBehalfOf": "string",
    "amount": "string",
    "source": {
      "paymentRail": "card",
      "currency": "string",
      "walletId": "string"
    },
    "destination": {
      "currency": "string",
      "walletId": "string",
      "walletAddress": "string"
    }
  }'
{
  "id": "string",
  "state": "awaiting_funds",
  "onBehalfOf": "string",
  "amount": "string",
  "source": {
    "paymentRail": "card",
    "currency": "string",
    "walletId": "string"
  },
  "destination": {
    "currency": "string",
    "walletId": "string",
    "walletAddress": "string"
  },
  "sourceInstructions": {
    "signedUrl": "http://example.com"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}