PutCustomerCallbackRequest
in package
Request object for PUT /customer/callback endpoint.
This endpoint allows wallets to register a callback URL with the anchor. The anchor will POST to this URL when the customer's verification status changes. The callback URL replaces any previously registered callback URL for the identified customer.
Callbacks enable real-time status updates without requiring the wallet to poll the GET /customer endpoint repeatedly. This is particularly useful for long-running verification processes.
Tags
Table of Contents
Properties
- $account : string|null
- $id : string|null
- $jwt : string|null
- $memo : string|null
- $memoType : string|null
- $url : string|null
Properties
$account
public
string|null
$account
= null
The Stellar account ID used to identify this customer. If many customers share the same Stellar account, the memo and memoType parameters should be included as well.
$id
public
string|null
$id
= null
The ID of the customer as returned in the response of a previous PUT request. If the customer has not been registered, they do not yet have an id.
$jwt
public
string|null
$jwt
= null
jwt token previously received from the anchor via the SEP-10 authentication flow
$memo
public
string|null
$memo
= null
the client-generated memo that uniquely identifies the customer. If a memo is present in the decoded SEP-10 JWT's sub value, it must match this parameter value. If a muxed account is used as the JWT's sub value, memos sent in requests must match the 64-bit integer subaccount ID of the muxed account. see: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#shared-omnibus-or-pooled-accounts
$memoType
public
string|null
$memoType
= null
(deprecated) type of memo. One of text, id or hash. Deprecated because memos should always be of type id, although anchors should continue to support this parameter for outdated clients. If hash, memo should be base64-encoded. If a memo is present in the decoded SEP-10 JWT's sub value, this parameter can be ignored. see: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md#shared-omnibus-or-pooled-accounts
$url
public
string|null
$url
= null
A callback URL that the SEP-12 server will POST to when the state of the account changes.