request_onchain_funds - Stellar Developer Docs

SEP-6 SEP-24 SEP-31 The user has to initiate transfer to the anchor

Params (11)

Please note that parameter structure within the request must contain named parameters as a by-name object, and not as positional arguments in a by-position array

string

required

The unique identifier of this transaction.A unique transaction identifier.

string

Human readable explanation of transaction status.A human readable message.

object

required

The amount expected in the payment

Show properties

string

required

A numerical representation of an amount of some asset.

string

required

The asset to be received by the Anchor

object

required

Amount sent by anchor to user

Show properties

string

required

A numerical representation of an amount of some asset.

string

required

The asset to be sent by anchor to user at end of transaction

object

This is required if the transaction is associated with a firm quote and for transactions where amount_in.asset and amount_out.asset are the same.

Show properties

string

required

A numerical representation of an amount of some asset.

string

required

The asset to be sent by anchor to user at end of transaction

object

required

Description of fees charged by the anchorDescription of fee charged by the anchor.

Show properties

number

required

string

required

object[]

Details about fee charged.

Show items

string

number

object

The amount expected in the payment

Show properties

string

required

A numerical representation of an amount of some asset.

string

Destination account

string

Value of memo to attach to transaction

string

Type of memo that anchor should attach to the transaction

string

Time and date by which user action is requiredA date and time.

Result

(request_onchain_fundsResponse)

string

A unique transaction identifier.

integer

Protocol of the transaction.Available options: 6, 24, 31

string

The kind of transaction that is desired.Available options: undefined, receive, deposit, deposit-exchange, withdrawal, withdrawal-exchange

string

Processing status of the transaction.Available options: pending_anchor, pending_trust, pending_user, pending_user_transfer_start, pending_user_transfer_complete, incomplete, no_market, too_small, too_large, pending_sender, pending_receiver, pending_transaction_info_update, pending_customer_info_update, completed, refunded, expired, error, pending_external, pending_stellar

object

The amount expected in the payment.

Show properties

string

A stringified amount of an asset.

string

An asset.

object

Amount expected/received by anchor.

Show properties

string

A stringified amount of an asset.

string

An asset.

object

The amount expected to be sent by anchor to user at end of transaction.

Show properties

string

A stringified amount of an asset.

string

An asset.

object

Description of fee charged by the anchor.

Show properties

number

required

string

required

object[]

Details about fee charged.

Show items

string

number

string

The id returned from a SEP-38 POST /quote response

string

Start date and time of transaction.

string

The date and time of transaction reaching the current status.

string

The date and time of transaction reaching completed or refunded status.

string

The date and time of receiving transfer.

string

Human readable explanation of transaction status

object

An object describing any on or offchain refund associated with this transaction.

Show properties

object

The total amount refunded in units of amount_in_asset.

Show properties

string

A numerical representation of an amount of some asset.

string

An asset.

object

The total amount charged in fees for processing all refund payments, in units of amount_in_asset.

Show properties

string

A numerical representation of an amount of some asset.

string

An asset.

object[]

A list of objects containing information on the individual payments made back as refunds.

Show items

string

The Stellar transaction hash.

string

object

The amount sent back for the payment identified by id, in units of amount_in_asset.

Show properties

string

A numerical representation of an amount of some asset.

string

An asset.

object

The amount charged as a fee for processing the refund, in units of amount_in_asset.

Show properties

string

A numerical representation of an amount of some asset.

string

An asset.

string

The date and time of requesting refund.

string

The date and time of making refund.

Example

Example request to the request_onchain_funds method. Request

curl -X POST \
-H 'Content-Type: application/json' \
-d '{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "request_onchain_funds",
  "params": {
    "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    "message": "Requesting onchain funds",
    "amount_in": {
      "amount": 1,
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_out": {
      "amount": 0.9,
      "asset": "iso4217:USD"
    },
    "fee_details": {
      "total": 0.1,
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_expected": {
      "amount": 1
    }
  }
}' \
https://platform-server.exampleanchor.com | jq

let requestBody = {
  jsonrpc: "2.0",
  id: 8675309,
  method: "request_onchain_funds",
  params: {
    transaction_id: "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    message: "Requesting onchain funds",
    amount_in: {
      amount: 1,
      asset:
        "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
    },
    amount_out: {
      amount: 0.9,
      asset: "iso4217:USD",
    },
    fee_details: {
      total: 0.1,
      asset:
        "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
    },
    amount_expected: {
      amount: 1,
    },
  },
};
let res = await fetch("https://platform-server.exampleanchor.com", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify(requestBody),
});
let json = await res.json();
console.log(json);

import json, requests
res = requests.post("https://platform-server.exampleanchor.com", json={
    "jsonrpc": "2.0",
    "id": 8675309,
    "method": "request_onchain_funds",
    "params": {
        "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
        "message": "Requesting onchain funds",
        "amount_in": {
            "amount": 1,
            "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
        },
        "amount_out": {
            "amount": 0.9,
            "asset": "iso4217:USD"
        },
        "fee_details": {
            "total": 0.1,
            "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
        },
        "amount_expected": {
            "amount": 1
        }
    }
})
print(json.dumps(res.json(), indent=4))

{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "request_onchain_funds",
  "params": {
    "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    "message": "Requesting onchain funds",
    "amount_in": {
      "amount": 1,
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_out": {
      "amount": 0.9,
      "asset": "iso4217:USD"
    },
    "fee_details": {
      "total": 0.1,
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_expected": {
      "amount": 1
    }
  }
}

Result

{
  "jsonrpc": "2.0",
  "id": 8675309,
  "result": {
    "id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    "sep": "24",
    "kind": "deposit",
    "status": "completed",
    "amount_expected": {
      "amount": "1",
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_in": {
      "amount": "1",
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "amount_out": {
      "amount": "0.9",
      "asset": "iso4217:USD"
    },
    "fee_details": {
      "total": "0.1",
      "asset": "stellar:USDC:GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5"
    },
    "started_at": "2023-08-04T10:04:06.280923Z",
    "updated_at": "2023-08-04T10:04:15.716233Z",
    "message": "Transaction complete",
    "source_account": "GB4GJAV4Q7DPGU7WI3H5TMVKEYZJ4JFLFEF3O3TRJKDPXK7NAMRBXWFL",
    "destination_account": "GDIN5ZULIOT5YPBIXJXFGNH4TCNTDKIA4ZF6QQE3S2P5P44BHCQQJNDC"
  }
}

​Params (11)

​Result

​Example

Params (11)

Result

Example