Package-level declarations

Types

Link copied to clipboard
data class Sep31FeeDetails(val total: String, val asset: String, val details: List<Sep31FeeDetailsDetails>? = null)

Fee breakdown applied to a SEP-31 transaction.

Link copied to clipboard
data class Sep31FeeDetailsDetails(val name: String, val amount: String, val description: String? = null)

Single line item within a SEP-31 fee breakdown.

Link copied to clipboard
data class Sep31InfoResponse(val receiveAssets: Map<String, Sep31ReceiveAssetInfo>)

Response payload returned by the SEP-31 GET /info endpoint.

Link copied to clipboard
data class Sep31PostTransactionsRequest(val amount: Double, val assetCode: String, val fundingMethod: String, val assetIssuer: String? = null, val destinationAsset: String? = null, val quoteId: String? = null, val senderId: String? = null, val receiverId: String? = null, val fields: Map<String, Any?>? = null, val lang: String? = null, val refundMemo: String? = null, val refundMemoType: String? = null)

Request body for the SEP-31 POST /transactions endpoint.

Link copied to clipboard
data class Sep31PostTransactionsResponse(val id: String, val stellarAccountId: String? = null, val stellarMemoType: String? = null, val stellarMemo: String? = null)

Response payload returned by SEP-31 POST /transactions.

Link copied to clipboard
data class Sep31ReceiveAssetInfo(val sep12Info: Sep31Sep12TypesInfo, val minAmount: Double? = null, val maxAmount: Double? = null, val feeFixed: Double? = null, val feePercent: Double? = null, val senderSep12Type: String? = null, val receiverSep12Type: String? = null, val fields: Map<String, Any?>? = null, val quotesSupported: Boolean? = null, val quotesRequired: Boolean? = null, val fundingMethods: List<String>? = null)

Per-asset configuration advertised by a Receiving Anchor in GET /info.

Link copied to clipboard
data class Sep31RefundPayment(val id: String, val amount: String, val fee: String)

Single on-chain refund payment within a SEP-31 Sep31Refunds aggregate.

Link copied to clipboard
data class Sep31Refunds(val amountRefunded: String, val amountFee: String, val payments: List<Sep31RefundPayment>)

Aggregate refund details for a SEP-31 transaction.

Link copied to clipboard
data class Sep31Sep12TypesInfo(val senderTypes: Map<String, String>, val receiverTypes: Map<String, String>)

KYC type definitions for sender and receiver customers in a SEP-31 asset offering.

Link copied to clipboard
class Sep31Service(val serviceUrl: String, httpClient: HttpClient? = null, httpRequestHeaders: Map<String, String>? = null)

SEP-31 Cross-Border Payments service client.

Link copied to clipboard
data class Sep31TransactionResponse(val id: String, val status: String, val statusEta: Long? = null, val statusMessage: String? = null, val amountIn: String? = null, val amountInAsset: String? = null, val amountOut: String? = null, val amountOutAsset: String? = null, val amountFee: String? = null, val amountFeeAsset: String? = null, val feeDetails: Sep31FeeDetails? = null, val quoteId: String? = null, val stellarAccountId: String? = null, val stellarMemoType: String? = null, val stellarMemo: String? = null, val startedAt: String? = null, val updatedAt: String? = null, val completedAt: String? = null, val stellarTransactionId: String? = null, val externalTransactionId: String? = null, val refunded: Boolean? = null, val refunds: Sep31Refunds? = null, val requiredInfoMessage: String? = null, val requiredInfoUpdates: Map<String, Any?>? = null)

Full state of a SEP-31 cross-border payment transaction.

Link copied to clipboard

Enumeration of SEP-31 transaction lifecycle statuses defined by the spec.