v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Initiate Interledger Transaction

An Interledger transaction is one that you use to send funds between two identities of different categories, i.e. either between yourself (a corporate) and a consumer, or vice versa. When moving funds between your corporate and a consumer, the initiate -> verify steps are followed, however no SMS OTP is sent for verification and the default verification code of '123456' will pass. Your corporate is already authenticated by means of having a valid API key.

post/wallets/send/inter/initiate

Headers

api-keystring required

api-key is available on the dashboard

Authorizationstring required

Request body

userIdstring required

The Id of the user who is sending this transaction

sourceAccountIdstring required

The Id of the account to debit

destinationAccountIdstring required

The Id of the account to credit

memostring

An optional memo - Alphanumeric string up to 100 characters in length

amountstring required

The amount denominated in the smallest divisible unit of the sending currency. For example: cents or satoshis

verificationMethod'sms' | 'passkey' | 'totp'

SCA factor one of sms (default), totp, or passkey. EUR and USDC sources only accept sms or passkey non-regulated crypto sources accept all three.

Response

200

challengeIdstring

dateExpiresstring

Example response

{
  "challengeId": "f9d0358c-c5af-4ee5-8b55-d9f6559df4c4",
  "dateExpires": "2023-08-23T11:36:23.586Z",
  "transaction": {
    "syncedOwnerId": "b2ccf978-2da7-4ac9-9db7-5398c4c6b212",
    "parentWalletId": "e1f5dca0-b78b-4695-8752-81b172a2ea90",
    "currency": "EUR",
    "sourceAccountId": "0148ae0856b1457ff3b59f2ac965b58e",
    "destinationAccountId": "5ad9f70b933ca275fee8de8ca684002d",
    "amount": "500",
    "memo": "extend",
    "senderAccountBalance": "734321",
    "status": "PENDING_2FA_CONFIRMATION",
    "txType": "INTER_LEDGER_SEND"
  }
}