Skip to main content
Version: 3.0.0

request_onchain_funds

SEP-6SEP-24SEP-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

1. transaction_id (required)

The unique identifier of this transaction.

string

A unique transaction identifier.

2. message

Human readable explanation of transaction status.

string

A human readable message.

3. amount_in (required)

The amount expected in the payment

amount
string
required

A numerical representation of an amount of some asset.

asset
string
required

The asset to be received by the Anchor

4. amount_out (required)

Amount sent by anchor to user

amount
string
required

A numerical representation of an amount of some asset.

asset
string
required

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

5. amount_out

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.

amount
string
required

A numerical representation of an amount of some asset.

asset
string
required

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

6. fee_details (required)

Description of fees charged by the anchor

Description of fee charged by the anchor.

total
number
required
asset
string
required
details
array[object]

Details about fee charged.

name
string
description
string
amount
number

7. amount_expected

The amount expected in the payment

amount
string
required

A numerical representation of an amount of some asset.

8. destination_account

Destination account

string

9. memo

Value of memo to attach to transaction

string

10. memo_type

Type of memo that anchor should attach to the transaction

string

11. user_action_required_by

Time and date by which user action is required

string

A date and time.

Result

(request_onchain_fundsResponse)
id
string

A unique transaction identifier.

sep
integer

Protocol of the transaction.

Allowed values:
62431
kind
string

The kind of transaction that is desired.

Allowed values:
undefinedreceivedepositdeposit-exchangewithdrawalwithdrawal-exchange
status
string

Processing status of the transaction.

Allowed values:
pending_anchorpending_trustpending_userpending_user_transfer_startpending_user_transfer_completeincompleteno_markettoo_smalltoo_largepending_senderpending_receiverpending_transaction_info_updatepending_customer_info_updatecompletedrefundedexpirederrorpending_externalpending_stellar
amount_expected
amount_expected

The amount expected in the payment.

amount
string

A stringified amount of an asset.

asset
string

An asset.

amount_in
amount_in

Amount expected/received by anchor.

amount
string

A stringified amount of an asset.

asset
string

An asset.

amount_out
amount_out

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

amount
string

A stringified amount of an asset.

asset
string

An asset.

fee_details
fee_details

Description of fee charged by the anchor.

total
number
required
asset
string
required
details
array[object]

Details about fee charged.

quote_id
string

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

started_at
string

Start date and time of transaction.

updated_at
string

The date and time of transaction reaching the current status.

completed_at
string

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

transfer_received_at
string

The date and time of receiving transfer.

message
string

Human readable explanation of transaction status

refunds
refunds

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

amount_refunded
object

The total amount refunded in units of amount_in_asset.

amount_fee
object

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

payments
array[object]

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

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

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