Skip to main content
POST
/
sandbox
/
send
Simulate sending funds
curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/sandbox/send \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "UMA-Q12345-REF",
  "currencyCode": "USD",
  "currencyAmount": 1000
}'
{
  "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
  "status": "CREATED",
  "type": "INCOMING",
  "source": {
    "accountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "currency": "USD"
  },
  "destination": {
    "accountId": "ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
    "currency": "EUR"
  },
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001",
  "platformCustomerId": "18d3e5f7b4a9c2",
  "settledAt": "2025-08-15T14:30:00Z",
  "createdAt": "2025-08-15T14:25:18Z",
  "updatedAt": "2025-08-15T14:30:00Z",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "sentAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "receivedAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "exchangeRate": 1.08,
  "fees": 10,
  "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
  "originalTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000003",
  "paymentInstructions": {
    "reference": "UMA-Q12345-REF",
    "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
    "bankAccountInfo": {
      "accountType": "CLABE",
      "clabeNumber": "123456789012345678",
      "bankName": "BBVA Mexico"
    }
  },
  "refund": {
    "reference": "UMA-Q12345-REFUND",
    "initiatedAt": "2025-08-15T14:30:00Z",
    "settledAt": "2025-08-15T14:30:00Z"
  },
  "rateDetails": {
    "counterpartyMultiplier": 1.08,
    "counterpartyFixedFee": 10,
    "gridApiMultiplier": 0.925,
    "gridApiFixedFee": 10,
    "gridApiVariableFeeRate": 0.003,
    "gridApiVariableFeeAmount": 30
  },
  "failureReason": "QUOTE_EXPIRED"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
reference
string
required

The unique reference code that was in the payment instructions

Example:

"UMA-Q12345-REF"

​
currencyCode
string
required

Currency code for the funds to be sent

Example:

"USD"

​
currencyAmount
integer
required

The amount to send in the smallest unit of the currency (eg. cents)

Required range: x > 0
Example:

1000

Response

Funds received successfully

​
id
string
required

Unique identifier for the transaction

Example:

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

​
status
enum<string>
required

Status of a payment transaction

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,
OUTGOING
​
source
object
required

Source account details

  • Account Source
  • UMA Address Source
​
destination
object
required

Destination account details

  • Account Destination
  • UMA Address Destination
​
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"

​
sentAmount
object
required

Amount sent in the sender's currency

​
paymentInstructions
object
required

Contains the reference code, banking details, and instructions needed to complete the payment

​
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"

​
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. Only applicable for transactions to/from UMA addresses.

Example:
{
  "FULL_NAME": "John Sender",
  "BIRTH_DATE": "1985-06-15",
  "NATIONALITY": "DE"
}
​
receivedAmount
object

Amount to be received by recipient in the recipient's currency

​
exchangeRate
number

Number of sending currency units per receiving currency unit.

Required range: x > 0
Example:

1.08

​
fees
integer

The fees associated with the quote in the smallest unit of the sending currency (eg. cents).

Required range: x >= 0
Example:

10

​
quoteId
string

The ID of the quote that was used to trigger this payment

Example:

"Quote:019542f5-b3e7-1d02-0000-000000000006"

​
originalTransactionId
string

ID of the original transaction that this transaction is retrying, if applicable

Example:

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

​
refund
object

The refund if transaction was refunded.

​
rateDetails
object

Details about the rate and fees for the transaction.

​
failureReason
enum<string>

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

Available options:
QUOTE_EXPIRED,
QUOTE_EXECUTION_FAILED,
LIGHTNING_PAYMENT_FAILED,
FUNDING_AMOUNT_MISMATCH,
COUNTERPARTY_POST_TX_FAILED,
TIMEOUT
⌘I