Skip to main content
POST
/
platform
/
external-accounts
curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/platform/external-accounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "USD",
  "accountInfo": {
    "accountType": "US_ACCOUNT",
    "accountNumber": "12345678901",
    "routingNumber": "123456789",
    "accountCategory": "CHECKING",
    "bankName": "Chase Bank",
    "platformAccountId": "ext_acc_123456",
    "beneficiary": {
      "beneficiaryType": "INDIVIDUAL",
      "fullName": "John Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      }
    }
  }
}'
{
  "id": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
  "customerId": "Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7",
  "status": "ACTIVE",
  "platformAccountId": "acc_123456789",
  "currency": "USD",
  "accountInfo": {
    "accountType": "US_ACCOUNT",
    "accountNumber": "123456789",
    "routingNumber": "987654321",
    "accountCategory": "CHECKING",
    "bankName": "Chase Bank",
    "beneficiary": {
      "fullName": "John Michael Doe",
      "birthDate": "1990-01-15",
      "nationality": "US",
      "address": {
        "line1": "123 Main Street",
        "line2": "Apt 4B",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      },
      "beneficiaryType": "INDIVIDUAL"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
currency
string
required

The ISO 4217 currency code

Example:

"USD"

​
accountInfo
object
required
  • US Account
  • CLABE Account
  • PIX Account
  • IBAN Account
  • UPI Account
  • Spark Wallet
​
customerId
string

The ID of the customer for whom to create the external account. If not provided, the external account will be created on behalf of the platform.

Example:

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

Response

External account created successfully

​
id
string
required

The system generated identifier of this account

Example:

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

​
status
enum<string>
required

Status of the external account

Available options:
PENDING,
ACTIVE,
UNDER_REVIEW,
INACTIVE
​
currency
string
required

The ISO 4217 currency code

Example:

"USD"

​
accountInfo
object
required
  • US Account
  • CLABE Account
  • PIX Account
  • IBAN Account
  • UPI Account
  • Spark Wallet
​
customerId
string

The customer this account is tied to, or null if the account is on behalf of the platform.

Example:

"Customer:da459a29-1fb7-41ce-a4cb-eb3a3c9fd7a7"

​
platformAccountId
string

Optional platform-specific identifier for this account

Example:

"acc_123456789"

⌘I