notify_onchain_funds_received

SEP - 6SEP - 24SEP - 31

Notify that the payment is being processed internally by anchor for SEP-6 or SEP-24. For SEP-31, notify that the payment is being processed by the Receiving Anchor. In the request, amount parameters are optional, but have a strict rule of how to set them. Either none, only amount_in, or all of fields (amount_in, amount_out, amount_fee) must be specified.

Params

(7)

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 ID of the transaction

string

2. message

Human readable explanation of transaction status

string

3. stellar_transaction_id (required)

Transaction id on Stellar network of the transfer

string

4. amount_in

Amount received by anchor.

amount

number

required

Amount of assets

5. amount_out

Amount expected to be sent by anchor to user. If set, both amount_in and fee_details must be specified

amount

number

required

Amount of assets

6. amount_fee

DEPRECATED in favor of fee_details. Amount of fee charged by anchor. If set, both amount_in and amount_out must be specified

amount

number

required

Amount of assets

7. fee_details

Description of fees charged by the anchor

total

number

required

asset

string

required

details

array[object]

Details about fee charged

name

string

description

string

amount

number

Result

(Response)

id

string

The ID of the transaction

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

object

The amount expected in the payment

asset

string

amount

string

amount_in

object

Amount expected/received by anchor

asset

string

amount

string

amount_out

object

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

asset

string

amount

string

amount_fee

object

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

asset

string

amount

string

fee_details

object

Description of fee charged by the anchor.

total

number

asset

string

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

object

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

Request

JSON

[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "method": "notify_onchain_funds_received",
    "params": {
      "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
      "message": "Onchain funds received",
      "stellar_transaction_id": "7...9",
      "amount_in": {
        "amount": 1
      }
    }
  }
]

Response

JSON

[
  {
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
      "id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
      "sep": "24 / 31",
      "kind": "deposit/withdrawal/receive",
      "status": "...",
      "amount_expected": {
        "amount": "1",
        "asset": "stellar:USDC:G...5"
      },
      "amount_in": {
        "amount": "1",
        "asset": "stellar:USDC:G...5"
      },
      "amount_out": {
        "amount": "0.9",
        "asset": "iso4217:USD"
      },
      "amount_fee": {
        "amount": "0.1",
        "asset": "stellar:USDC:G...5"
      },
      "started_at": "2023-08-04T10:04:06.280923Z",
      "updated_at": "2023-08-04T10:04:15.716233Z",
      "message": "Transaction status message",
      "source_account": "G...W",
      "destination_account": "G...S"
    }
  }
]