Simulate payment send to test receiving an UMA payment

curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/sandbox/uma/receive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "senderUmaAddress": "[email protected]",
  "receivingCurrencyCode": "USD",
  "receivingCurrencyAmount": 1000,
  "receiverUmaAddress": "[email protected]",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
}
'

{
  "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",
  "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",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "reconciliationInstructions": {
    "reference": "UMA-Q12345-REF"
  },
  "rateDetails": {
    "gridApiMultiplier": 0.925,
    "gridApiFixedFee": 10,
    "gridApiVariableFeeRate": 0.003,
    "gridApiVariableFeeAmount": 30
  },
  "failureReason": "LNURLP_FAILED"
}

POST

sandbox

uma

receive

Simulate payment send to test receiving an UMA payment

curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/sandbox/uma/receive \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "senderUmaAddress": "[email protected]",
  "receivingCurrencyCode": "USD",
  "receivingCurrencyAmount": 1000,
  "receiverUmaAddress": "[email protected]",
  "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000001"
}
'

{
  "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",
  "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",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "reconciliationInstructions": {
    "reference": "UMA-Q12345-REF"
  },
  "rateDetails": {
    "gridApiMultiplier": 0.925,
    "gridApiFixedFee": 10,
    "gridApiVariableFeeRate": 0.003,
    "gridApiVariableFeeAmount": 30
  },
  "failureReason": "LNURLP_FAILED"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

senderUmaAddress

string

required

UMA address of the sender from the sandbox

Example:

"[email protected]"

receivingCurrencyCode

string

required

The currency code for the receiving amount

Example:

"USD"

receivingCurrencyAmount

integer<int64>

required

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

Example:

1000

receiverUmaAddress

string

UMA address of the receiver (optional if customerId is provided)

Example:

"[email protected]"

customerId

string

System ID of the receiver (optional if receiverUmaAddress is provided)

Example:

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

Response

Payment triggered successfully

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

Account Source · object

required

Source account details

Account Source
UMA Address Source

Show child attributes

source.accountId

string

required

Source account identifier

Example:

"InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"

source.currency

string

required

Currency code for the source account

Example:

"USD"

destination

Account Destination · object

required

Destination account details

Account Destination
UMA Address Destination

Show child attributes

destination.accountId

string

required

Destination account identifier

Example:

"ExternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"

destination.currency

string

required

Currency code for the destination account

Example:

"EUR"

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

receivedAmount.amount

integer<int64>

required

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

Example:

12550

receivedAmount.currency

object

required

Show child attributes

receivedAmount.currency.code

string

Three-letter currency code (ISO 4217) for fiat currencies. Some cryptocurrencies may use their own ticker symbols (e.g. "BTC" for Bitcoin, "USDC" for USDC, etc.)

Example:

"USD"

receivedAmount.currency.name

string

Full name of the currency

Example:

"United States Dollar"

receivedAmount.currency.symbol

string

Symbol of the currency

Example:

"$"

receivedAmount.currency.decimals

integer

Number of decimal places for the currency

Required range: x >= 0

Example:

2

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

reconciliationInstructions

object

Included for all transactions except those with "CREATED" status

Show child attributes

reconciliationInstructions.reference

string

required

Unique reference code that must be included with the payment to match it with the correct incoming transaction

Example:

"UMA-Q12345-REF"

rateDetails

object

Details about the rate and fees for the transaction.

Show child attributes

rateDetails.gridApiMultiplier

number<double>

required

The underlying multiplier from the mSATS to the receiving currency, including variable fees.

Example:

0.925

rateDetails.gridApiFixedFee

integer<int64>

required

The fixed fee charged by the Grid product to execute the quote in the smallest unit of the receiving currency (eg. cents).

Required range: x >= 0

Example:

10

rateDetails.gridApiVariableFeeRate

number<double>

required

The variable fee rate charged by the Grid product to execute the quote as a percentage of the receiving currency amount.

Example:

0.003

rateDetails.gridApiVariableFeeAmount

number<int64>

required

The variable fee amount charged by the Grid product to execute the quote in the smallest unit of the receiving currency (eg. cents). This is the receiving amount times gridApiVariableFeeRate.

Required range: x >= 0

Example:

30

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

Simulate sending funds Simulate funding an internal account

⌘I

Using the API

API documentation

Simulate payment send to test receiving an UMA payment

Authorizations

Body

Response