notify_customer_info_updated - Stellar Developer Docs

SEP-6 SEP-31 The customer’s status for the transaction has been updated. Use this method to notify the wallet of the status change. If customer_id and customer_type are provided, the transaction status will reflect the customer’s status. If not, the transaction status will default to the standard pending status for the SEP.

Params (4)

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.

string

The SEP-12 ID of the customer

string

The SEP-12 type of the customer

Result

(notify_customer_info_updatedResponse)

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 notify_customer_info_updated method. Request

curl -X POST \
-H 'Content-Type: application/json' \
-d '{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "notify_customer_info_updated",
  "params": {
    "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    "message": "Customer info updated",
    "customer_id": "45f8884d-d6e1-477f-a680-503179263359",
    "customer_type": "sep31-receiver"
  }
}' \
https://platform-server.exampleanchor.com | jq

let requestBody = {
  jsonrpc: "2.0",
  id: 8675309,
  method: "notify_customer_info_updated",
  params: {
    transaction_id: "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    message: "Customer info updated",
    customer_id: "45f8884d-d6e1-477f-a680-503179263359",
    customer_type: "sep31-receiver",
  },
};
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": "notify_customer_info_updated",
    "params": {
        "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
        "message": "Customer info updated",
        "customer_id": "45f8884d-d6e1-477f-a680-503179263359",
        "customer_type": "sep31-receiver"
    }
})
print(json.dumps(res.json(), indent=4))

{
  "jsonrpc": "2.0",
  "id": 8675309,
  "method": "notify_customer_info_updated",
  "params": {
    "transaction_id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
    "message": "Customer info updated",
    "customer_id": "45f8884d-d6e1-477f-a680-503179263359",
    "customer_type": "sep31-receiver"
  }
}

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 (4)

​Result

​Example

Params (4)

Result

Example