persistence

Documentation

Index

• Constants
• Variables
• type Asset
• type ChargesInformation
• type FItoFICCTMemoData
• type FItoFICCTNonPiiData
• type FItoFITransaction
• type FItoFITransactionStatus
• type Fee
• type MongoDBOperations
  • func CreateAdminServicePersistenceOperations() (MongoDBOperations, error)
  • func (mo MongoDBOperations) GetTxnDetails(w http.ResponseWriter, request *http.Request)
  • func (mo MongoDBOperations) StoreFiToFiCCTMemo(w http.ResponseWriter, request *http.Request)
• type PaymentIdentification
• type TransactionDetails
• type TransactionReceipt

Constants

const (
	//INSTRUCTION_ID ID for message
	INSTRUCTION_ID = "INSTRUCTION_ID"
	//TRANSACTION_ID id from ledger
	TRANSACTION_ID = "TRANSACTION_ID"
	//DATE_RANGE type for range query
	DATE_RANGE = "DATE_RANGE"
)

Variables

var LOGGER = logging.MustGetLogger("administration-service")

Types

type Asset

type Asset struct {

	// alphanumeric code for the asset - USD, XLM, etc
	// Required: true
	AssetCode *string `json:"asset_code" bson:"asset_code"`

	// the stellar address for the asset issuer
	// Required: true
	IssuerID *string `json:"issuer_id" bson:"issuer_id"`

	// native or credit
	// Required: true
	AssetType *string `json:"asset_type" bson:"asset_type"`
}

type ChargesInformation

type ChargesInformation struct {

	// amount of fee charged
	// Required: true
	Amount *float64 `json:"amount" bson:"amount"`

	// asset
	// Required: true
	Asset *Asset `json:"asset" bson:"asset"`
}

type FItoFICCTMemoData

type FItoFICCTMemoData struct {
	ID string `json:"_id,omitempty" bson:"_id,omitempty"`

	// fitoficct non pii data
	// Required: true
	FitoficctNonPiiData *FItoFICCTNonPiiData `json:"fitoficctnonpiidata"  bson:"fitoficctnonpiidata"`

	// the hash value of the FItoFICCTPiiData
	// Required: true
	FitoficctPiiHash *string `json:"fitoficct_pii_hash" bson:"fitoficct_pii_hash"`

	// this is the unique id for this transaction generated by the distributed ledger (but not in txn memo hash)
	TransactionIdentifier string `json:"transaction_identifier,omitempty"  bson:"transaction_identifier,omitempty"`
	// the participant domain of the OFI (payment sender)
	// Required: true
	OfiDomain *string `json:"ofi_domain" bson:"ofi_domain"`

	// the timestamp for this transaction
	// Required: true
	TimeStamp *int64 `json:"time_stamp" bson:"time_stamp"`

	// transaction status
	// Required: true
	TransactionStatus *string `json:"transaction_status" bson:"transaction_status"`
}

type FItoFICCTNonPiiData

type FItoFICCTNonPiiData struct {

	// The name of the operating or issuing account from which the payment is to be sent
	// Required: true
	AccountNameSend *string `json:"account_name_send" bson:"account_name_send"`

	// The RFI address where the payment is to be sent - received during federation protocol
	CreditorPaymentAddress string `json:"creditor_payment_address,omitempty" bson:"creditor_payment_address"`

	// Generated by originator, a unique ID for this entire use case
	// Required: true
	EndToEndID *string `json:"end_to_end_id" bson:"end_to_end_id"`

	// The exchange rate between settlement asset and beneficiary asset. not required if asset is same
	// Required: true
	// Multiple Of: 1e-07
	ExchangeRate *float64 `json:"exchange_rate" bson:"exchange_rate"`

	// transaction details
	// Required: true
	TransactionDetails *TransactionDetails `json:"transactiondetails" bson:"transactiondetails"`
}

type FItoFITransaction

type FItoFITransaction struct {

	// transaction details
	// Required: true
	TransactionDetails *TransactionDetails `json:"transaction_details"`

	// transaction receipt
	// Required: true
	TransactionReceipt *TransactionReceipt `json:"transaction_receipt"`
}

type FItoFITransactionStatus

type FItoFITransactionStatus struct {

	// This would capture the new status of a transaction while transaction travel through payment flow.
	// Required: true
	Status *string `json:"status" bson:"status"`

	// Timestamp of the status change according to World Wire
	// Required: true
	TimeStamp *int64 `json:"time_stamp" bson:"time_stamp"`
}

FItoFITransactionStatus fitoFITransactionStatus

Transaction's change of status information

type Fee

type Fee struct {

	// The fee amount, should be a float64 number
	// Required: true
	// Multiple Of: 1e-07
	Cost *float64 `json:"cost" bson:"cost"`

	// cost asset
	// Required: true
	CostAsset *Asset `json:"costasset" bson:"costasset"`
}

type MongoDBOperations

type MongoDBOperations struct {
	// contains filtered or unexported fields
}

func CreateAdminServicePersistenceOperations

func CreateAdminServicePersistenceOperations() (MongoDBOperations, error)

func (MongoDBOperations) GetTxnDetails

func (mo MongoDBOperations) GetTxnDetails(w http.ResponseWriter, request *http.Request)

func (MongoDBOperations) StoreFiToFiCCTMemo

func (mo MongoDBOperations) StoreFiToFiCCTMemo(w http.ResponseWriter, request *http.Request)

type PaymentIdentification

type PaymentIdentification struct {

	// Generated by originator, a unique ID for this entire use case
	EndToEndID string `json:"end_to_end_id,omitempty" bson:"end_to_end_id,omitempty"`

	// Generated by originator, a unique ID for this specific request
	InstructionID string `json:"instruction_id,omitempty" bson:"instruction_id,omitempty"`
}

type TransactionDetails

type TransactionDetails struct {

	// The amount the beneficiary should receive in beneficiary currency
	// Required: true
	// Multiple Of: 1e-07
	AmountBeneficiary *float64 `json:"amount_beneficiary" bson:"amount_beneficiary"`

	// The amount of the settlement.
	// Required: true
	// Multiple Of: 1e-07
	AmountSettlement *float64 `json:"amount_settlement" bson:"amount_settlement"`

	// The asset code for the beneficiary
	// Required: true
	AssetCodeBeneficiary *string `json:"asset_code_beneficiary" bson:"asset_code_beneficiary"`

	// asset settlement
	// Required: true
	AssetSettlement *Asset `json:"assetsettlement" bson:"assetsettlement"`

	// fee creditor
	// Required: true
	FeeCreditor *Fee `json:"feecreditor" bson:"feecreditor"`

	// The ID that identifies the OFI Participant on the WorldWire network (i.e. uk.yourbankintheUK.payments.ibm.com).
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	OfiID *string `json:"ofi_id" bson:"ofi_id"`

	// The ID that identifies the RFI Participant on the WorldWire network (i.e. uk.yourbankintheUK.payments.ibm.com).
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	RfiID *string `json:"rfi_id" bson:"rfi_id"`

	// The preferred settlement method for this payment request (DA, DO, or XLM)
	// Required: true
	SettlementMethod *string `json:"settlement_method" bson:"settlement_method"`
}

type TransactionReceipt

type TransactionReceipt struct {

	// The timestamp of the transaction.
	// Required: true
	TimeStamp *int64 `json:"time_stamp"`

	// A unique transaction identifier generated by the ledger.
	// Required: true
	TransactionID *string `json:"transaction_id"`

	// For DA (digital asset) or DO (digital obligation) ops, this will be "cleared".  For cryptocurrencies, this will be "settled".
	// Required: true
	TransactionStatus *string `json:"transaction_status"`
}