Create a transfer-out request

Transfer funds from an internal account to an external account for a specific customer.

POST /transfer-out

cURL

cURL

curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/transfer-out \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "source": {
    "accountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
  },
  "destination": {
    "accountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "paymentRail": "ACH"
  },
  "amount": 12550,
  "remittanceInformation": "12345"
}
'

import LightsparkGrid from '@lightsparkdev/grid';

const client = new LightsparkGrid({
  username: process.env['GRID_CLIENT_ID'], // This is the default and can be omitted
  password: process.env['GRID_CLIENT_SECRET'], // This is the default and can be omitted
});

const transaction = await client.transferOut.create({
  destination: {
    accountId: 'ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965',
    paymentRail: 'ACH',
  },
  source: { accountId: 'InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123' },
  amount: 12550,
  remittanceInformation: '12345',
});

console.log(transaction);

package com.lightspark.grid.example

import com.lightspark.grid.client.LightsparkGridClient
import com.lightspark.grid.client.okhttp.LightsparkGridOkHttpClient
import com.lightspark.grid.models.transferin.InternalAccountReference
import com.lightspark.grid.models.transferin.Transaction
import com.lightspark.grid.models.transferout.TransferOutRequest

fun main() {
    val client: LightsparkGridClient = LightsparkGridOkHttpClient.fromEnv()

    val params: TransferOutRequest = TransferOutRequest.builder()
        .destination(TransferOutRequest.Destination.builder()
            .accountId("ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965")
            .build())
        .source(InternalAccountReference.builder()
            .accountId("InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123")
            .build())
        .build()
    val transaction: Transaction = client.transferOut().create(params)
}

201

{
  "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
  "type": "INCOMING",
  "destination": {
    "destinationType": "ACCOUNT",
    "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
    "currency": "EUR"
  },
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "platformCustomerId": "18d3e5f7b4a9c2",
  "receivedAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "settledAt": "2025-08-15T14:30:00Z",
  "createdAt": "2025-08-15T14:25:18Z",
  "updatedAt": "2025-08-15T14:30:00Z",
  "receiptDeliveryConfirmedAt": "2025-08-15T14:31:00Z",
  "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "source": {
    "sourceType": "ACCOUNT",
    "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "currency": "USD"
  },
  "fees": 10,
  "reconciliationInstructions": {
    "reference": "UMA-Q12345-REF",
    "transactionHash": "0x9f2c6b6f4b6c8f2a8d9e0b1c2d3e4f5061728394a5b6c7d8e9f00112233445566"
  },
  "rateDetails": {
    "gridApiMultiplier": 0.925,
    "gridApiFixedFee": 10,
    "gridApiVariableFeeRate": 0.003,
    "gridApiVariableFeeAmount": 30
  }
}

{
  "status": 400,
  "message": "<string>",
  "details": {}
}

{
  "status": 401,
  "message": "<string>",
  "details": {}
}

{
  "status": 404,
  "message": "<string>",
  "details": {}
}

{
  "status": 500,
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Headers

Idempotency-Key · string

A unique identifier for the request. If the same key is sent multiple times, the server will return the same response as the first request.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

source · object · required

Source internal account details

Show child attributes

destination · object · required

Destination external account details

Show child attributes

amount · integer<int64>

Amount in the smallest unit of the currency (e.g., cents for USD/EUR, satoshis for BTC)

Example:

12550

remittanceInformation · string

Free-form information about the payment that travels with it to the recipient. The field this populates depends on the payment rail: for ACH it populates the Addenda record, for FedNow and RTP it populates the remittanceInformation field, and for wires it populates the OBI (Originator to Beneficiary Information) / beneficiary information.

Maximum string length: 80

Example:

"12345"

Response

201

application/json

Transfer-out request created successfully

Incoming Transaction

Outgoing Transaction

Card Transaction

id · string · required

Unique identifier for the transaction

Example:

"Transaction:019542f5-b3e7-1d02-0000-000000000004"

status · enum<string> · required

Status of a payment transaction.

Status	Description
CREATED	Initial lookup has been created
PENDING	Quote has been created
PROCESSING	Funding has been received and payment initiated
COMPLETED	Cross border payment has been received, converted and payment has been sent to the offramp network
REJECTED	Receiving institution or wallet rejected payment, payment has been refunded
FAILED	An error occurred during payment
REFUNDED	Payment was unable to complete and refunded
EXPIRED	Quote has expired

Available options: CREATED, PENDING, PROCESSING, COMPLETED, REJECTED, FAILED, REFUNDED, EXPIRED

type · enum<string> · required

Type of transaction (incoming payment or outgoing payment)

Available options: INCOMING

direction · enum<string> · required

Whether this transaction credits or debits the customer's account.

Available options: CREDIT, DEBIT

destination · Account Destination · object · required

Destination account details

Account Destination

UMA Address Destination

Show child attributes

customerId · string · required

System ID of the customer (sender for outgoing, recipient for incoming)

Example:

"Customer:019542f5-b3e7-1d02-0000-000000000001"

platformCustomerId · string · required

Platform-specific ID of the customer (sender for outgoing, recipient for incoming)

Example:

"18d3e5f7b4a9c2"

receivedAmount · object · required

Amount received in the recipient's currency

Show child attributes

settledAt · string<date-time>

When the payment was or will be settled

Example:

"2025-08-15T14:30:00Z"

createdAt · string<date-time>

When the transaction was created

Example:

"2025-08-15T14:25:18Z"

updatedAt · string<date-time>

When the transaction was last updated

Example:

"2025-08-15T14:30:00Z"

receiptDeliveryConfirmedAt · string<date-time>

The time at which the platform confirmed delivery of the receipt to their customer.

Example:

"2025-08-15T14:31:00Z"

agentId · string

If this transaction was initiated by an agent, the system-generated ID of that agent. Absent for platform-initiated transactions.

Example:

"Agent:019542f5-b3e7-1d02-0000-000000000042"

description · string

Optional memo or description for the payment

Example:

"Payment for invoice #1234"

counterpartyInformation · object

Additional information about the counterparty, if available and relevant to the transaction and platform.

Example:

{
  "FULL_NAME": "John Sender",
  "BIRTH_DATE": "1985-06-15",
  "NATIONALITY": "DE"
}

source · Account Source · object

Source account details

Account Source

UMA Address Source

External Funding Source

Show child attributes

fees · integer<int64>

The total fees available from the receive quote in the smallest unit of the receiving currency (eg. cents).

Required range: x >= 0

Example:

10

reconciliationInstructions · object

Included for all transactions except those with "CREATED" status

Show child attributes

rateDetails · object

Details about the rate and fees for the transaction.

Show child attributes

failureReason · enum<string>

If the transaction failed, this field provides the reason for failure.

Available options: LNURLP_FAILED, PAY_REQUEST_FAILED, PAYMENT_APPROVAL_WEBHOOK_ERROR, PAYMENT_APPROVAL_TIMED_OUT, OFFRAMP_FAILED, MISSING_MANDATORY_PAYEE_DATA, QUOTE_EXPIRED, QUOTE_EXECUTION_FAILED