model

package
v0.0.0-...-1305305 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2021 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// AccountCustomerAccountTypeChecking captures enum value "checking"
	AccountCustomerAccountTypeChecking string = "checking"

	// AccountCustomerAccountTypeSavings captures enum value "savings"
	AccountCustomerAccountTypeSavings string = "savings"
)
View Source
const (
	// AssetAssetTypeDO captures enum value "DO"
	AssetAssetTypeDO string = "DO"

	// AssetAssetTypeDA captures enum value "DA"
	AssetAssetTypeDA string = "DA"

	// AssetAssetTypeNative captures enum value "native"
	AssetAssetTypeNative string = "native"
)
View Source
const (

	// BlocklistTypeCURRENCY captures enum value "CURRENCY"
	BlocklistTypeCURRENCY string = "CURRENCY"

	// BlocklistTypeCOUNTRY captures enum value "COUNTRY"
	BlocklistTypeCOUNTRY string = "COUNTRY"

	// BlocklistTypeINSTITUTION captures enum value "INSTITUTION"
	BlocklistTypeINSTITUTION string = "INSTITUTION"
)
View Source
const (

	// ComplianceReceiptComplianceStatusOK captures enum value "OK"
	ComplianceReceiptComplianceStatusOK string = "OK"

	// ComplianceReceiptComplianceStatusDenied captures enum value "Denied"
	ComplianceReceiptComplianceStatusDenied string = "Denied"
)
View Source
const (

	// ComplianceReceiptSanctionsStatusOK captures enum value "OK"
	ComplianceReceiptSanctionsStatusOK string = "OK"

	// ComplianceReceiptSanctionsStatusDenied captures enum value "Denied"
	ComplianceReceiptSanctionsStatusDenied string = "Denied"
)
View Source
const (

	// ExchangeReceiptStatusExchangeOK captures enum value "OK"
	ExchangeReceiptStatusExchangeOK string = "OK"

	// ExchangeReceiptStatusExchangeDenied captures enum value "Denied"
	ExchangeReceiptStatusExchangeDenied string = "Denied"
)
View Source
const (

	// GeoTypeArea captures enum value "area"
	GeoTypeArea string = "area"

	// GeoTypePoint captures enum value "point"
	GeoTypePoint string = "point"
)
View Source
const (

	// InternalComplianceCheckResponseDispositionOK captures enum value "OK"
	InternalComplianceCheckResponseDispositionOK string = "OK"

	// InternalComplianceCheckResponseDispositionDenied captures enum value "Denied"
	InternalComplianceCheckResponseDispositionDenied string = "Denied"
)
View Source
const (

	// ParticipantRoleMM captures enum value "MM"
	ParticipantRoleMM string = "MM"

	// ParticipantRoleIS captures enum value "IS"
	ParticipantRoleIS string = "IS"
)
View Source
const (

	// ParticipantStatusStatusInactive captures enum value "inactive"
	ParticipantStatusStatusInactive string = "inactive"

	// ParticipantStatusStatusActive captures enum value "active"
	ParticipantStatusStatusActive string = "active"

	// ParticipantStatusStatusSuspended captures enum value "suspended"
	ParticipantStatusStatusSuspended string = "suspended"
)
View Source
const (

	// PayoutLocationTypeBank captures enum value "Bank"
	PayoutLocationTypeBank string = "Bank"

	// PayoutLocationTypeNonBankFinancialInstitution captures enum value "Non-Bank Financial Institution"
	PayoutLocationTypeNonBankFinancialInstitution string = "Non-Bank Financial Institution"

	// PayoutLocationTypeMobileNetworkOperator captures enum value "Mobile Network Operator"
	PayoutLocationTypeMobileNetworkOperator string = "Mobile Network Operator"

	// PayoutLocationTypeOther captures enum value "Other"
	PayoutLocationTypeOther string = "Other"
)
View Source
const (

	// PayoutLocationCategoryNameDelivery captures enum value "delivery"
	PayoutLocationCategoryNameDelivery string = "delivery"

	// PayoutLocationCategoryNameCashPickup captures enum value "cash_pickup"
	PayoutLocationCategoryNameCashPickup string = "cash_pickup"

	// PayoutLocationCategoryNameAgencyPickup captures enum value "agency_pickup"
	PayoutLocationCategoryNameAgencyPickup string = "agency_pickup"

	// PayoutLocationCategoryNameMobile captures enum value "mobile"
	PayoutLocationCategoryNameMobile string = "mobile"

	// PayoutLocationCategoryNameBankAccount captures enum value "bank_account"
	PayoutLocationCategoryNameBankAccount string = "bank_account"
)
View Source
const (

	// FederationProtocolResponseMemoTypeText captures enum value "text"
	FederationProtocolResponseMemoTypeText string = "text"
)

Variables

This section is empty.

Functions

func GetAssetType

func GetAssetType(assetCode string) string

func IsValidAssetCode

func IsValidAssetCode(currencyCode string) error

Check if DO or DA currency code is valid ISO4217 currency code

func IsValidDACode

func IsValidDACode(currencyCode string) error

Check if currency code for DA is valid ISO4217 currency code

func IsValidDOCode

func IsValidDOCode(currencyCode string) error

Check if currency code for DO is valid ISO4217 currency code

Types

type Account

type Account struct {

	// The address that was created on the ledger.
	// Required: true
	Address *string `json:"address" bson:"address"`

	// A name to identify this account.
	Name string `json:"name,omitempty" bson:"name"`
}

Account account

Account swagger:model Account

func (*Account) MarshalBinary

func (m *Account) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Account) UnmarshalBinary

func (m *Account) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Account) Validate

func (m *Account) Validate(formats strfmt.Registry) error

Validate validates this account

type AccountCustomer

type AccountCustomer struct {

	// Identifier for the customer account
	// Required: true
	AccountNumber *string `json:"account_number" bson:"account_number"`

	// Account type for customer account
	// Required: true
	// Enum: [checking savings]
	AccountType *string `json:"account_type" bson:"account_type"`

	// A routing number to an institution
	// Required: true
	RoutingNumber *string `json:"routing_number" bson:"routing_number"`
}

AccountCustomer accountCustomer

Account customer swagger:model AccountCustomer

func (*AccountCustomer) MarshalBinary

func (m *AccountCustomer) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountCustomer) UnmarshalBinary

func (m *AccountCustomer) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountCustomer) Validate

func (m *AccountCustomer) Validate(formats strfmt.Registry) error

Validate validates this account customer

type AccountFoundResponse

type AccountFoundResponse struct {

	// Other info returned about the participant or the final receiver
	OtherInfo string `json:"other_info,omitempty"`

	// The stellar address to interact with in the context of this transaction
	// Required: true
	StellarNetworkAddress *string `json:"stellar_network_address"`
}

AccountFoundResponse accountFoundResponse

Account Found Response swagger:model AccountFoundResponse

func (*AccountFoundResponse) MarshalBinary

func (m *AccountFoundResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountFoundResponse) UnmarshalBinary

func (m *AccountFoundResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountFoundResponse) Validate

func (m *AccountFoundResponse) Validate(formats strfmt.Registry) error

Validate validates this account found response

type AccountReq

type AccountReq struct {

	// approval ids
	// Required: true
	ApprovalIds []string `json:"approvalIds" validate:"required"`

	// name
	// Required: true
	Name *string `json:"name" validate:"required"`

	// participant Id
	// Required: true
	ParticipantID *string `json:"participantId" validate:"required"`
}

AccountReq AccountRequest swagger:model AccountReq

func (*AccountReq) MarshalBinary

func (m *AccountReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AccountReq) UnmarshalBinary

func (m *AccountReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AccountReq) Validate

func (m *AccountReq) Validate(formats strfmt.Registry) error

Validate validates this account req

type Address

type Address struct {

	// The building number or identifier.
	// Required: true
	BuildingNumber *string `json:"building_number" bson:"building_number"`

	// Name of the city or town.
	// Required: true
	City *string `json:"city"`

	// Country code of the location.
	// Required: true
	Country *string `json:"country"`

	// Postal code for the location.
	// Required: true
	PostalCode *string `json:"postal_code" bson:"postal_code"`

	// Name of the state.
	// Required: true
	State *string `json:"state"`

	// The street name.
	// Required: true
	Street *string `json:"street"`
}

Address address

Address swagger:model Address

func (*Address) MarshalBinary

func (m *Address) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Address) UnmarshalBinary

func (m *Address) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Address) Validate

func (m *Address) Validate(formats strfmt.Registry) error

Validate validates this address

type AnchorWithdrawalRequest

type AnchorWithdrawalRequest struct {

	// Name of operating or issuing account to send asset from.
	// Required: true
	AccountName *string `json:"account_name"`

	// amount
	// Required: true
	// Multiple Of: 1e-07
	Amount *float64 `json:"amount"`

	// The ID that identifies the Anchor Participant on the WorldWire network.
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	AnchorID *string `json:"anchor_id"`

	// The identifier of the asset issued by the Anchor. For a list of assets, retrieve all World Wire assets from the /assets endpoint.
	// Required: true
	AssetCode *string `json:"asset_code"`

	// creditor
	// Required: true
	Creditor *PaymentActor `json:"creditor"`

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

	// An optional way for customers to name a transaction.
	TransactionNote string `json:"transaction_note,omitempty"`
}

AnchorWithdrawalRequest settlement

Settlement swagger:model AnchorWithdrawalRequest

func (*AnchorWithdrawalRequest) MarshalBinary

func (m *AnchorWithdrawalRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AnchorWithdrawalRequest) UnmarshalBinary

func (m *AnchorWithdrawalRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AnchorWithdrawalRequest) Validate

func (m *AnchorWithdrawalRequest) Validate(formats strfmt.Registry) error

Validate validates this anchor withdrawal request

type AnchorWithdrawalResponse

type AnchorWithdrawalResponse struct {

	// The fee amount, should be a float64 number
	// Multiple Of: 1e-07
	AmountFee float64 `json:"amount_fee,omitempty" bson:"amount_fee"`

	// The identifier of the asset the anchor issued. For a list of assets, retrieve all World Wire assets from the /assets endpoint.
	AssetCode string `json:"asset_code,omitempty"`

	// A reference hash to refer transaction in anchor's system of record.
	ReferenceHash string `json:"reference_hash,omitempty"`

	// A hash that identifies the transaction on the ledger.
	TransactionID string `json:"transaction_id,omitempty"`

	// An optional way for customers to name a transaction.
	TransactionNote string `json:"transaction_note,omitempty"`
}

AnchorWithdrawalResponse settlementReceipt

Settlement Receipt swagger:model AnchorWithdrawalResponse

func (*AnchorWithdrawalResponse) MarshalBinary

func (m *AnchorWithdrawalResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AnchorWithdrawalResponse) UnmarshalBinary

func (m *AnchorWithdrawalResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AnchorWithdrawalResponse) Validate

func (m *AnchorWithdrawalResponse) Validate(formats strfmt.Registry) error

Validate validates this anchor withdrawal response

type ApprovalUpdate

type ApprovalUpdate struct {

	// status
	// Required: true
	Status *string `json:"status" validate:"required"`

	// uid approve
	// Required: true
	UIDApprove *string `json:"uid_approve" validate:"required"`
}

ApprovalUpdate ApprovalUpdate swagger:model ApprovalUpdate

func (*ApprovalUpdate) MarshalBinary

func (m *ApprovalUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ApprovalUpdate) UnmarshalBinary

func (m *ApprovalUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ApprovalUpdate) Validate

func (m *ApprovalUpdate) Validate(formats strfmt.Registry) error

Validate validates this approval update

type Asset

type Asset struct {
	// Alphanumeric code for the asset - USD, XLM, etc
	// Required: true
	AssetCode *string `json:"asset_code" bson:"asset_code"`

	// The type of asset. Options include digital obligation, "DO", digital asset "DA", or a cryptocurrency "native".
	// Required: true
	// Enum: [DO DA native]
	AssetType *string `json:"asset_type" bson:"asset_type"`

	// The asset issuer's participant id.
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	IssuerID string `json:"issuer_id,omitempty" bson:"issuer_id"`
}

Asset asset

Details of the asset being transacted swagger:model Asset

func (*Asset) MarshalBinary

func (m *Asset) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Asset) UnmarshalBinary

func (m *Asset) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Asset) Validate

func (m *Asset) Validate(formats strfmt.Registry) error

Validate validates this asset

type AssetBalance

type AssetBalance struct {

	// The name of the account, operting account name or "issuing" for issuing account
	// Required: true
	AccountName *string `json:"account_name"`

	// A name to identify the asset
	// Required: true
	AssetCode *string `json:"asset_code"`

	// Balance for a given asset
	// Required: true
	Balance *string `json:"balance"`

	// Participant id to identify the issuer for this asset
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	IssuerID string `json:"issuer_id,omitempty"`
}

AssetBalance balance

Balance swagger:model AssetBalance

func (*AssetBalance) MarshalBinary

func (m *AssetBalance) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AssetBalance) UnmarshalBinary

func (m *AssetBalance) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AssetBalance) Validate

func (m *AssetBalance) Validate(formats strfmt.Registry) error

Validate validates this asset balance

type AssetReq

type AssetReq struct {

	// approval ids
	// Required: true
	ApprovalIds []string `json:"approvalIds" validate:"required"`

	// asset code
	// Required: true
	AssetCode *string `json:"asset_code" validate:"required"`

	// asset type
	// Required: true
	AssetType *string `json:"asset_type" validate:"required"`

	// balance
	Balance int64 `json:"balance,omitempty" validate:"omitempty"`

	// currency
	Currency string `json:"currency,omitempty" validate:"omitempty"`

	// issuer id
	IssuerID string `json:"issuer_id,omitempty" validate:"omitempty"`

	// participant Id
	// Required: true
	ParticipantID *string `json:"participantId" validate:"required"`

	// status
	Status string `json:"status,omitempty" validate:"omitempty"`

	// time updated
	TimeUpdated int64 `json:"timeUpdated,omitempty" validate:"omitempty"`
}

AssetReq AssetRequest swagger:model AssetReq

func (*AssetReq) MarshalBinary

func (m *AssetReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AssetReq) UnmarshalBinary

func (m *AssetReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AssetReq) Validate

func (m *AssetReq) Validate(formats strfmt.Registry) error

Validate validates this asset req

type AssetType

type AssetType struct {

	// account name
	// Required: true
	AccountName *string `json:"account_name" validate:"required"`

	// asset code
	// Required: true
	AssetCode *string `json:"asset_code" validate:"required"`

	// balance
	// Required: true
	Balance *int64 `json:"balance" validate:"required"`

	// issuer id
	IssuerID string `json:"issuer_id,omitempty" validate:"omitempty"`
}

AssetType AssetType swagger:model AssetType

func (*AssetType) MarshalBinary

func (m *AssetType) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AssetType) UnmarshalBinary

func (m *AssetType) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AssetType) Validate

func (m *AssetType) Validate(formats strfmt.Registry) error

Validate validates this asset type

type AuthAccount

type AuthAccount struct {

	// account
	Account *Account `json:"account,omitempty"`

	// auth token
	Token string `json:"token,omitempty"`
}

AuthAccount authAccount

Account with the token swagger:model AuthAccount

func (*AuthAccount) MarshalBinary

func (m *AuthAccount) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuthAccount) UnmarshalBinary

func (m *AuthAccount) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuthAccount) Validate

func (m *AuthAccount) Validate(formats strfmt.Registry) error

Validate validates this auth account

type Blocklist

type Blocklist struct {

	// The id of the block type
	ID string `json:"id,omitempty"`

	// The name of the block type
	Name string `json:"name,omitempty"`

	// The type of the blocklist element
	// Required: true
	// Enum: [CURRENCY COUNTRY INSTITUTION]
	Type *string `json:"type"`

	// The value of the block type
	// Required: true
	Value []string `json:"value"`
}

Blocklist blocklist

A blocklist that records all the currencies/countries/particpants that is forbidden to transact with swagger:model Blocklist

func (*Blocklist) MarshalBinary

func (m *Blocklist) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Blocklist) UnmarshalBinary

func (m *Blocklist) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Blocklist) Validate

func (m *Blocklist) Validate(formats strfmt.Registry) error

Validate validates this blocklist

type BlocklistReq

type BlocklistReq struct {

	// approval Id
	// Required: true
	ApprovalID *string `json:"approvalId" validate:"required"`

	// type
	// Required: true
	Type *string `json:"type" validate:"required"`

	// value
	// Required: true
	Value *string `json:"value" validate:"required"`
}

BlocklistReq BlocklistRequest swagger:model BlocklistReq

func (*BlocklistReq) MarshalBinary

func (m *BlocklistReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BlocklistReq) UnmarshalBinary

func (m *BlocklistReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BlocklistReq) Validate

func (m *BlocklistReq) Validate(formats strfmt.Registry) error

Validate validates this blocklist req

type Comparison

type Comparison struct {

	// The type of logical comparison. The default option is "eq" (equal to), but other options include "gt" (greater than), "lt" (less than), "ge" (greater than or equal to), and "le" (less than or equal to).
	//
	// Required: true
	Operator *string `json:"operator"`

	// The amount you want to compare.
	// Required: true
	// Minimum: 1
	Threshold *float64 `json:"threshold"`
}

Comparison comparison

Comparison swagger:model Comparison

func (*Comparison) MarshalBinary

func (m *Comparison) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Comparison) UnmarshalBinary

func (m *Comparison) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Comparison) Validate

func (m *Comparison) Validate(formats strfmt.Registry) error

Validate validates this comparison

type Compliance

type Compliance struct {

	// The hash of the entire one-way Send (payment) bundle that is stored in the txn memo field on the ledger.
	// Required: true
	Compliance *string `json:"compliance"`

	// pending send
	// Required: true
	PendingSend *Send `json:"pending_send"`
}

Compliance compliance

Compliance swagger:model compliance

func (*Compliance) MarshalBinary

func (m *Compliance) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Compliance) UnmarshalBinary

func (m *Compliance) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Compliance) Validate

func (m *Compliance) Validate(formats strfmt.Registry) error

Validate validates this compliance

type ComplianceReceipt

type ComplianceReceipt struct {

	// AML/KYC/Sanctions info of the recipient.
	// Required: true
	AmlKyc *string `json:"aml_kyc"`

	// The unique identifier for the compliance check done prior to this payment.
	//
	// Required: true
	ComplianceID *string `json:"compliance_id"`

	// "OK" or "Denied"
	//
	// Required: true
	// Enum: [OK Denied]
	ComplianceStatus *string `json:"compliance_status"`

	// "OK" or "Denied"
	//
	// Enum: [OK Denied]
	SanctionsStatus string `json:"sanctions_status,omitempty"`
}

ComplianceReceipt complianceReceipt

Compliance Receipt swagger:model ComplianceReceipt

func (*ComplianceReceipt) MarshalBinary

func (m *ComplianceReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceReceipt) UnmarshalBinary

func (m *ComplianceReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceReceipt) Validate

func (m *ComplianceReceipt) Validate(formats strfmt.Registry) error

Validate validates this compliance receipt

type Coordinate

type Coordinate struct {

	// The latitude of the geo coordinates
	// Required: true
	Lat *float64 `json:"lat"`

	// The longitude of the geo coordinates
	// Required: true
	Long *float64 `json:"long"`
}

Coordinate coordinate

Geographic coordinates for a location. Based on https://schema.org/geo swagger:model Coordinate

func (*Coordinate) MarshalBinary

func (m *Coordinate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Coordinate) UnmarshalBinary

func (m *Coordinate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Coordinate) Validate

func (m *Coordinate) Validate(formats strfmt.Registry) error

Validate validates this coordinate

type Cursor

type Cursor struct {

	// Cursor location of the last payment received on a given account.
	//
	Cursor string `json:"cursor,omitempty"`
}

Cursor cursor

Cursor swagger:model Cursor

func (*Cursor) MarshalBinary

func (m *Cursor) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Cursor) UnmarshalBinary

func (m *Cursor) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Cursor) Validate

func (m *Cursor) Validate(formats strfmt.Registry) error

Validate validates this cursor

type DestInfo

type DestInfo struct {

	// AML/KYC/Sanctions info of the recipient
	// Required: true
	AmlKycInfo *string `json:"aml_kyc_info"`

	// The unique identifier for the compliance check done prior to this payment
	// Required: true
	ComplianceIdentification *string `json:"compliance_identification"`
}

DestInfo destInfo

Dest Info swagger:model DestInfo

func (*DestInfo) MarshalBinary

func (m *DestInfo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DestInfo) UnmarshalBinary

func (m *DestInfo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DestInfo) Validate

func (m *DestInfo) Validate(formats strfmt.Registry) error

Validate validates this dest info

type DiscoverParticipantResponse

type DiscoverParticipantResponse struct {

	// Can be either 'issuing' or the Participants operating account's name.
	// Required: true
	AccountName *string `json:"account_name"`

	// The ledger address which is expected to be the recipient for this transaction, once compliance checks are complete.
	// Required: true
	Address *string `json:"address"`
}

DiscoverParticipantResponse addressLedger

Address Ledger swagger:model DiscoverParticipantResponse

func (*DiscoverParticipantResponse) MarshalBinary

func (m *DiscoverParticipantResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DiscoverParticipantResponse) UnmarshalBinary

func (m *DiscoverParticipantResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DiscoverParticipantResponse) Validate

func (m *DiscoverParticipantResponse) Validate(formats strfmt.Registry) error

Validate validates this discover participant response

type Draft

type Draft struct {

	// The name of the account with which the transactions needs to be signed
	// Required: true
	AccountName *string `json:"account_name"`

	// This will be signed reference envelope to verify against partcipant's signature for authenticity.
	// Required: true
	// Format: byte
	IDSigned *strfmt.Base64 `json:"id_signed"`

	// This will be unsigned reference envelope to verify against partcipant's signature for authenticity.
	// Required: true
	// Format: byte
	IDUnsigned *strfmt.Base64 `json:"id_unsigned"`

	// Identifier for transaction.
	TransactionID string `json:"transaction_id,omitempty"`

	// The unsigned transaction envelope to be signed by the participant.
	// Required: true
	// Format: byte
	TransactionUnsigned *strfmt.Base64 `json:"transaction_unsigned"`
}

Draft draft

draft swagger:model Draft

func (*Draft) MarshalBinary

func (m *Draft) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Draft) UnmarshalBinary

func (m *Draft) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Draft) Validate

func (m *Draft) Validate(formats strfmt.Registry) error

Validate validates this draft

type Exchange

type Exchange struct {

	// OFI Participant operating or issuing account for receiving target asset.
	//
	// Required: true
	AccountNameReceive *string `json:"account_name_receive"`

	// OFI Participant operating or issuing account for source asset transmit.
	//
	// Required: true
	AccountNameSend *string `json:"account_name_send"`

	// Amount of source asset to be exchanged.
	// Required: true
	Amount *decimal.Decimal `json:"amount"`

	// quote
	// Required: true
	Quote *Quote `json:"quote"`
}

Exchange exchange

Exchange swagger:model Exchange

func (*Exchange) MarshalBinary

func (m *Exchange) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Exchange) UnmarshalBinary

func (m *Exchange) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Exchange) Validate

func (m *Exchange) Validate(formats strfmt.Registry) error

Validate validates this exchange

type ExchangeEnvelope

type ExchangeEnvelope struct {

	// base64 encoded [exchange](??base_url??/docs/??version??/api/participant-client-callback-api?jump=model_exchange) object
	// Required: true
	Exchange *string `json:"exchange"`

	// base64 encoded exchange object signature
	// Required: true
	Signature *string `json:"signature"`
}

ExchangeEnvelope exchangeEnvelope

Exchange Envelope swagger:model ExchangeEnvelope

func (*ExchangeEnvelope) MarshalBinary

func (m *ExchangeEnvelope) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExchangeEnvelope) UnmarshalBinary

func (m *ExchangeEnvelope) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExchangeEnvelope) Validate

func (m *ExchangeEnvelope) Validate(formats strfmt.Registry) error

Validate validates this exchange envelope

type ExchangeReceipt

type ExchangeReceipt struct {

	// exchange
	// Required: true
	Exchange *Exchange `json:"exchange"`

	// Options are "OK" or "Denied".
	// Required: true
	// Enum: [OK Denied]
	StatusExchange *string `json:"status_exchange"`

	// Timestamp when the exchange occured.
	TimeExecuted int64 `json:"time_executed,omitempty"`

	// Transacted amount of source asset.
	// Required: true
	TransactedAmountSource *decimal.Decimal `json:"transacted_amount_source"`

	// Transacted amount of target asset.
	// Required: true
	TransactedAmountTarget *decimal.Decimal `json:"transacted_amount_target"`

	// Transacted hash.
	// Required: true
	TransactionHash *string `json:"transaction_hash"`
}

ExchangeReceipt exchangeReceipt

Exchange Receipt swagger:model ExchangeReceipt

func (*ExchangeReceipt) MarshalBinary

func (m *ExchangeReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExchangeReceipt) UnmarshalBinary

func (m *ExchangeReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExchangeReceipt) Validate

func (m *ExchangeReceipt) Validate(formats strfmt.Registry) error

Validate validates this exchange receipt

type FItoFICCTPiiData

type FItoFICCTPiiData struct {

	// creditor information
	// Required: true
	CreditorInformation *PaymentActor `json:"creditor_information"`

	// debtor information
	// Required: true
	DebtorInformation *PaymentActor `json:"debtor_information"`
}

FItoFICCTPiiData fitoFICCTPiiData

FI to FI CCT Pii Data - contains PII information swagger:model FItoFICCTPiiData

func (*FItoFICCTPiiData) MarshalBinary

func (m *FItoFICCTPiiData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FItoFICCTPiiData) UnmarshalBinary

func (m *FItoFICCTPiiData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FItoFICCTPiiData) Validate

func (m *FItoFICCTPiiData) Validate(formats strfmt.Registry) error

Validate validates this f ito f i c c t pii data

type FItoFITransaction

type FItoFITransaction struct {

	// The transaction receipt.
	// Required: true
	TransactionReceipt []*TransactionReceipt `json:"transaction_receipt"`

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

FItoFITransaction transaction

Transaction swagger:model FItoFITransaction

func (*FItoFITransaction) MarshalBinary

func (m *FItoFITransaction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FItoFITransaction) UnmarshalBinary

func (m *FItoFITransaction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FItoFITransaction) Validate

func (m *FItoFITransaction) Validate(formats strfmt.Registry) error

Validate validates this f ito f i transaction

type FItoFITransactionRequest

type FItoFITransactionRequest struct {

	// End Date of the range in which transactions are being quried.
	// Format: date
	EndDate strfmt.Date `json:"end_date,omitempty"`

	// A name to identify from which OFI the request is coming from
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	OfiID *string `json:"ofi_id"`

	// Page number for pagination.
	PageNumber int64 `json:"page_number,omitempty"`

	// A name to identify the transaction
	QueryData string `json:"query_data,omitempty"`

	// A type to identify what kind of data is passed
	// Required: true
	QueryType *string `json:"query_type"`

	// Start Date of the range in which transactions are being quried.
	// Format: date
	StartDate strfmt.Date `json:"start_date,omitempty"`

	// Number of transactions for each page
	TransactionBatch int64 `json:"transaction_batch,omitempty"`
}

FItoFITransactionRequest fitoFITransactionRequest

Transaction GET request parameters swagger:model FItoFITransactionRequest

func (*FItoFITransactionRequest) MarshalBinary

func (m *FItoFITransactionRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FItoFITransactionRequest) UnmarshalBinary

func (m *FItoFITransactionRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FItoFITransactionRequest) Validate

func (m *FItoFITransactionRequest) Validate(formats strfmt.Registry) error

Validate validates this f ito f i transaction request

type FederationProtocolError

type FederationProtocolError struct {

	// The detail about the error with the federation protocol request
	// Required: true
	Detail *string `json:"detail"`
}

FederationProtocolError federationProtocolError

Federation protocol error response swagger:model FederationProtocolError

func (*FederationProtocolError) MarshalBinary

func (m *FederationProtocolError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FederationProtocolError) UnmarshalBinary

func (m *FederationProtocolError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FederationProtocolError) Validate

func (m *FederationProtocolError) Validate(formats strfmt.Registry) error

Validate validates this federation protocol error

type FederationProtocolResponse

type FederationProtocolResponse struct {

	// The account ID of the receiver.  Should be the same as the account identifier for GFTN
	// Required: true
	AccountID *string `json:"account_id"`

	// Optional, should be used for the compliance and payment operation
	// Required: true
	Memo *string `json:"memo"`

	// Should always be "text" for GFTN
	// Required: true
	// Enum: [text]
	MemoType *string `json:"memo_type"`

	// The stellar address of account which, once compliance checks are complete, is expected to be the receiving address for this transaction
	ReceivingAccountAddress string `json:"receiving_account_address,omitempty"`
}

FederationProtocolResponse federationProtocolResponse

Federation protocol response swagger:model FederationProtocolResponse

func (*FederationProtocolResponse) MarshalBinary

func (m *FederationProtocolResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FederationProtocolResponse) UnmarshalBinary

func (m *FederationProtocolResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FederationProtocolResponse) Validate

func (m *FederationProtocolResponse) Validate(formats strfmt.Registry) error

Validate validates this federation protocol response

type Fee

type Fee struct {

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

	// costasset
	// Required: true
	Costasset *Asset `json:"costasset"`
}

Fee fee

Fee swagger:model Fee

func (*Fee) MarshalBinary

func (m *Fee) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Fee) UnmarshalBinary

func (m *Fee) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Fee) Validate

func (m *Fee) Validate(formats strfmt.Registry) error

Validate validates this fee

type FeesRequest

type FeesRequest struct {

	// Amount the OFI sends to the RFI on the ledger (not inclusive of RFI Fees). The recipient will receive this amount minus the RFI fees. If this attribute is set, amount_payout should not be filled in.
	//
	// Multiple Of: 1e-07
	AmountGross float64 `json:"amount_gross,omitempty"`

	// Amount (in payout asset) the sender would like the recipient to receive from the RFI. This is different from the amount_gross parameter since the sender will need to confirm that they are willing to pay the RFI's fee to make the payment to the recipient. If this attribute is set, amount_gross should not be set.
	//
	// Multiple Of: 1e-07
	AmountPayout float64 `json:"amount_payout,omitempty"`

	// Amount (in settlement asset) the OFI gives to the RFI on the ledger (inclusive of RFI Fees).
	//
	// Multiple Of: 1e-07
	AmountSettlement float64 `json:"amount_settlement,omitempty"`

	// The three-letter asset code of the fiat payment which will be made by the Participant to their ultimate beneficiary.
	//
	// Required: true
	AssetPayout *string `json:"asset_payout"`

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

	// details payout location
	DetailsPayoutLocation *PayoutLocation `json:"details_payout_location,omitempty"`

	// Identifier of the Participant who initiated the fee request.
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ParticipantID *string `json:"participant_id"`

	// Unique identifier for this fee request.
	// Required: true
	RequestID *string `json:"request_id"`
}

FeesRequest feesRequest

The information required to determine the fees related to a payment a Participant would like to execute.

swagger:model FeesRequest

func (*FeesRequest) MarshalBinary

func (m *FeesRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FeesRequest) UnmarshalBinary

func (m *FeesRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FeesRequest) Validate

func (m *FeesRequest) Validate(formats strfmt.Registry) error

Validate validates this fees request

type FinancialInstitutionDefinition

type FinancialInstitutionDefinition struct {

	// The name of the Institution.
	// Required: true
	Name *string `json:"name"`

	// The ID that identifies a 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}$
	ParticipantID *string `json:"participant_id"`
}

FinancialInstitutionDefinition institution

Institution swagger:model FinancialInstitutionDefinition

func (*FinancialInstitutionDefinition) MarshalBinary

func (m *FinancialInstitutionDefinition) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FinancialInstitutionDefinition) UnmarshalBinary

func (m *FinancialInstitutionDefinition) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FinancialInstitutionDefinition) Validate

func (m *FinancialInstitutionDefinition) Validate(formats strfmt.Registry) error

Validate validates this financial institution definition

type FitoFICCTMemoData

type FitoFICCTMemoData struct {

	// The hash value of the FI to FI CCT Pii Data
	// Required: true
	FitoficctPiiHash *string `json:"fitoficct_pii_hash" bson:"fitoficct_pii_hash"`

	// fitoficctnonpiidata
	// Required: true
	Fitoficctnonpiidata *FitoFICCTNonPiiData `json:"fitoficctnonpiidata"`

	// Unique autogenerate ID for mongoDB primary key
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ID string `json:"id,omitempty" bson:"_id"`

	// This is the message name of the transaction request
	// Required: true
	MessageName *string `json:"message_name" bson:"message_name"`

	// This is the message type of the transaction request
	// Required: true
	MessageType *string `json:"message_type" bson:"message_type"`

	// The participant id of the OFI (payment sender)
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	OfiID *string `json:"ofi_id" bson:"ofi_domain"`

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

	// This is the unique id for this transaction generated by the distributed ledger (but not in txn memo hash)
	TransactionIdentifier []string `json:"transaction_identifier" bson:"transaction_identifier"`

	// This would capture the new status of a transaction while transaction travel through payment flow.
	// Required: true
	TransactionStatus []*TransactionReceipt `json:"transaction_status" bson:"transaction_status"`
}

FitoFICCTMemoData fitoFICCTMemoData

FI to FI CCT Memo Data - the hash value of this will be stored in the transaction memo field swagger:model fitoFICCTMemoData

func (*FitoFICCTMemoData) MarshalBinary

func (m *FitoFICCTMemoData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FitoFICCTMemoData) UnmarshalBinary

func (m *FitoFICCTMemoData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FitoFICCTMemoData) Validate

func (m *FitoFICCTMemoData) Validate(formats strfmt.Registry) error

Validate validates this fito f i c c t memo data

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"`

	// This is the unique instruction id of the message
	// Required: true
	InstructionID *string `json:"instruction_id" bson:"instruction_id"`

	// This is the unique instruction id of the original pacs.008 message
	// Required: true
	OriginalInstructionID *string `json:"original_instruction_id" bson:"original_instruction_id"`

	// This is the reference to the original credit transfer message
	// Required: true
	OriginalMessageID *string `json:"original_message_id" bson:"original_message_id"`

	// transactiondetails
	// Required: true
	Transactiondetails *TransactionDetails `json:"transactiondetails"`
}

FitoFICCTNonPiiData fitoFICCTNonPiiData

FI to FI CCT Non-Pii Data swagger:model FitoFICCTNonPiiData

func (*FitoFICCTNonPiiData) MarshalBinary

func (m *FitoFICCTNonPiiData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FitoFICCTNonPiiData) UnmarshalBinary

func (m *FitoFICCTNonPiiData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FitoFICCTNonPiiData) Validate

func (m *FitoFICCTNonPiiData) Validate(formats strfmt.Registry) error

Validate validates this fito f i c c t non pii data

type Funding

type Funding struct {

	// The name of an operating account or "issuing" for an issuing account.
	//
	AccountName string `json:"account_name,omitempty"`

	// The amount that the Anchor is funding the Participant.
	// Required: true
	// Multiple Of: 1e-07
	AmountFunding *float64 `json:"amount_funding"`

	// Identifier of the World Wire Anchor that will fund the Participant with stablecoins. (i.e., "thebestbankintheUK")
	//
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	AnchorID *string `json:"anchor_id"`

	// Identifier of the stable coin asset issued by the Anchor. For a list of assets, retrieve all World Wire assets from the /assets endpoint.
	//
	// Required: true
	AssetCodeIssued *string `json:"asset_code_issued"`

	// Generated by the anchor, a unique ID for this funding request
	// Required: true
	EndToEndID *string `json:"end_to_end_id"`

	// An optional way for anchor to name a transaction.
	MemoTransaction string `json:"memo_transaction,omitempty"`

	// Identifier of the World Wire Participant that will receive the funding.
	//
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ParticipantID *string `json:"participant_id"`
}

Funding funding

Details about a Funding swagger:model Funding

func (*Funding) MarshalBinary

func (m *Funding) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Funding) UnmarshalBinary

func (m *Funding) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Funding) Validate

func (m *Funding) Validate(formats strfmt.Registry) error

Validate validates this funding

type FundingInstruction

type FundingInstruction struct {

	// details funding
	DetailsFunding *Funding `json:"details_funding,omitempty"`

	// Unsigned transaction xdr related to the funding. This will need to be signed in the next step.
	//
	InstructionUnsigned string `json:"instruction_unsigned,omitempty"`
}

FundingInstruction fundingInstruction

Funding Instruction swagger:model FundingInstruction

func (*FundingInstruction) MarshalBinary

func (m *FundingInstruction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingInstruction) UnmarshalBinary

func (m *FundingInstruction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingInstruction) Validate

func (m *FundingInstruction) Validate(formats strfmt.Registry) error

Validate validates this funding instruction

type FundingReceipt

type FundingReceipt struct {

	// details funding
	DetailsFunding *Funding `json:"details_funding,omitempty"`

	// receipt funding
	ReceiptFunding *TransactionReceipt `json:"receipt_funding,omitempty"`
}

FundingReceipt fundingReceipt

Funding Receipt swagger:model FundingReceipt

func (*FundingReceipt) MarshalBinary

func (m *FundingReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FundingReceipt) UnmarshalBinary

func (m *FundingReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FundingReceipt) Validate

func (m *FundingReceipt) Validate(formats strfmt.Registry) error

Validate validates this funding receipt

type GatewayResponse

type GatewayResponse struct {

	// The set of data to be posted to World Wire.
	// Required: true
	Data []interface{} `json:"data"`

	// The unix timestamp of the message being retrieved
	//
	// Required: true
	Timestamp *string `json:"timestamp"`
}

GatewayResponse gatewayResponse

The message payload for participant to post data to World Wire swagger:model GatewayResponse

func (*GatewayResponse) MarshalBinary

func (m *GatewayResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GatewayResponse) UnmarshalBinary

func (m *GatewayResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GatewayResponse) Validate

func (m *GatewayResponse) Validate(formats strfmt.Registry) error

Validate validates this gateway response

type Geo

type Geo struct {

	// The geo coordinates
	// Required: true
	Coordinates []*Coordinate `json:"coordinates"`

	// The type of location. Options include "point" if the location is a single pickup location, or "area" if it's a region.
	//
	// Required: true
	// Enum: [area point]
	Type *string `json:"type"`
}

Geo geo

Geographic coordinates for a location. Based on https://schema.org/geo swagger:model Geo

func (*Geo) MarshalBinary

func (m *Geo) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Geo) UnmarshalBinary

func (m *Geo) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Geo) Validate

func (m *Geo) Validate(formats strfmt.Registry) error

Validate validates this geo

type Info

type Info struct {

	// address1
	// Required: true
	Address1 *string `json:"address1" validate:"required"`

	// address2
	Address2 string `json:"address2,omitempty" validate:"omitempty"`

	// city
	// Required: true
	City *string `json:"city" validate:"required"`

	// country
	// Required: true
	Country *string `json:"country" validate:"required"`

	// geo lat
	// Required: true
	GeoLat *string `json:"geo_lat" validate:"required"`

	// geo lon
	// Required: true
	GeoLon *string `json:"geo_lon" validate:"required"`

	// institution Id
	InstitutionID string `json:"institutionId,omitempty" validate:"omitempty"`

	// kind
	// Required: true
	Kind *string `json:"kind" validate:"required"`

	// logo url
	LogoURL string `json:"logo_url,omitempty" validate:"omitempty"`

	// name
	// Required: true
	Name *string `json:"name" validate:"required"`

	// site url
	SiteURL string `json:"site_url,omitempty" validate:"omitempty"`

	// slug
	// Required: true
	Slug *string `json:"slug" validate:"required"`

	// state
	State string `json:"state,omitempty" validate:"omitempty"`

	// status
	// Required: true
	Status *string `json:"status" validate:"required"`

	// zip
	Zip string `json:"zip,omitempty" validate:"omitempty"`
}

Info InstitutionInfo swagger:model Info

func (*Info) MarshalBinary

func (m *Info) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Info) UnmarshalBinary

func (m *Info) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Info) Validate

func (m *Info) Validate(formats strfmt.Registry) error

Validate validates this info

type Institution

type Institution struct {

	// info
	// Required: true
	Info *Info `json:"info"`

	// nodes
	Nodes []*Node `json:"nodes"`
}

Institution PortalInstitution swagger:model Institution

func (*Institution) MarshalBinary

func (m *Institution) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Institution) UnmarshalBinary

func (m *Institution) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Institution) Validate

func (m *Institution) Validate(formats strfmt.Registry) error

Validate validates this institution

type InternalAdminDraft

type InternalAdminDraft struct {

	// The unsigned transaction envelope to be signed by IBM account.
	// Required: true
	// Format: byte
	TransactionUnsigned *strfmt.Base64 `json:"transaction_unsigned"`
}

InternalAdminDraft internalAdminDraft

draft swagger:model InternalAdminDraft

func (*InternalAdminDraft) MarshalBinary

func (m *InternalAdminDraft) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InternalAdminDraft) UnmarshalBinary

func (m *InternalAdminDraft) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InternalAdminDraft) Validate

func (m *InternalAdminDraft) Validate(formats strfmt.Registry) error

Validate validates this internal admin draft

type InternalComplianceCheckRequest

type InternalComplianceCheckRequest struct {

	// The JSON string of the full ISO-20022 message containing the details of the transaction
	// Required: true
	ClearingMessage *string `json:"clearing_message"`

	// The sending account and participant id (i.e. 101010101*odfi.payments.worldwire.io)
	// Required: true
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	Sender *string `json:"sender"`

	// The XDR of the transaction (unsigned) which will be initiated as soon as compliance check is complete
	StellarTransaction string `json:"stellar_transaction,omitempty"`
}

InternalComplianceCheckRequest internalComplianceCheckRequest

InternalComplianceCheckRequest swagger:model InternalComplianceCheckRequest

func (*InternalComplianceCheckRequest) MarshalBinary

func (m *InternalComplianceCheckRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InternalComplianceCheckRequest) UnmarshalBinary

func (m *InternalComplianceCheckRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InternalComplianceCheckRequest) Validate

func (m *InternalComplianceCheckRequest) Validate(formats strfmt.Registry) error

Validate validates this internal compliance check request

type InternalComplianceCheckResponse

type InternalComplianceCheckResponse struct {

	// AML/KYC/Sanctions info of the recipient
	// Required: true
	AmlKycInfo *string `json:"aml_kyc_info"`

	// The unique identifier for the compliance check done prior to this payment
	// Required: true
	ComplianceIdentification *string `json:"compliance_identification"`

	// OK or Denied
	// Required: true
	// Enum: [OK Denied]
	Disposition *string `json:"disposition"`
}

InternalComplianceCheckResponse internalComplianceCheckResponse

InternalComplianceCheckResponse swagger:model InternalComplianceCheckResponse

func (*InternalComplianceCheckResponse) MarshalBinary

func (m *InternalComplianceCheckResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InternalComplianceCheckResponse) UnmarshalBinary

func (m *InternalComplianceCheckResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InternalComplianceCheckResponse) Validate

Validate validates this internal compliance check response

type InternalDraft

type InternalDraft struct {

	// The name of the account with which the transactions needs to be signed
	// Required: true
	AccountName *string `json:"account_name"`

	// Identifier for transaction.
	TransactionID string `json:"transaction_id,omitempty"`

	// The unsigned transaction envelope to be signed by IBM account.
	// Required: true
	// Format: byte
	TransactionUnsigned *strfmt.Base64 `json:"transaction_unsigned"`
}

InternalDraft internalDraft

draft swagger:model internalDraft

func (*InternalDraft) MarshalBinary

func (m *InternalDraft) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InternalDraft) UnmarshalBinary

func (m *InternalDraft) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InternalDraft) Validate

func (m *InternalDraft) Validate(formats strfmt.Registry) error

Validate validates this internal draft

type KillswitchReq

type KillswitchReq struct {

	// account address
	// Required: true
	AccountAddress *string `json:"accountAddress" validate:"required"`

	// approval ids
	// Required: true
	ApprovalIds []string `json:"approvalIds" validate:"required"`

	// participant Id
	// Required: true
	ParticipantID *string `json:"participantId" validate:"required"`

	// reactivate approved by
	ReactivateApprovedBy string `json:"reactivateApprovedBy,omitempty" validate:"omitempty"`

	// reactivate rejected by
	ReactivateRejectedBy string `json:"reactivateRejectedBy,omitempty" validate:"omitempty"`

	// reactivate requested by
	ReactivateRequestedBy string `json:"reactivateRequestedBy,omitempty" validate:"omitempty"`

	// status
	// Required: true
	Status *string `json:"status" validate:"required"`

	// suspend approved by
	SuspendApprovedBy string `json:"suspendApprovedBy,omitempty" validate:"omitempty"`

	// suspend rejected by
	SuspendRejectedBy string `json:"suspendRejectedBy,omitempty" validate:"omitempty"`

	// suspend requested by
	SuspendRequestedBy string `json:"suspendRequestedBy,omitempty" validate:"omitempty"`
}

KillswitchReq KillswitchRequest swagger:model KillswitchReq

func (*KillswitchReq) MarshalBinary

func (m *KillswitchReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*KillswitchReq) UnmarshalBinary

func (m *KillswitchReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*KillswitchReq) Validate

func (m *KillswitchReq) Validate(formats strfmt.Registry) error

Validate validates this killswitch req

type Node

type Node struct {

	// approval ids
	ApprovalIds []string `json:"approvalIds" validate:"omitempty"`

	// bic
	// Required: true
	Bic *string `json:"bic" validate:"required"`

	// country code
	// Required: true
	CountryCode *string `json:"countryCode" validate:"required"`

	// initialized
	// Required: true
	Initialized *bool `json:"initialized" validate:"required"`

	// institution Id
	// Required: true
	InstitutionID *string `json:"institutionId" validate:"required"`

	// participant Id
	// Required: true
	ParticipantID *string `json:"participantId" validate:"required"`

	// role
	// Required: true
	Role *string `json:"role" validate:"required"`

	// status
	// Required: true
	Status []string `json:"status" validate:"required"`

	// update
	Update *Node `json:"update,omitempty"`

	// version
	Version string `json:"version,omitempty" validate:"omitempty"`
}

Node InstitutionNode swagger:model Node

func (*Node) MarshalBinary

func (m *Node) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Node) UnmarshalBinary

func (m *Node) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Node) Validate

func (m *Node) Validate(formats strfmt.Registry) error

Validate validates this node

type Obligation

type Obligation struct {

	// balance
	Balance *AssetBalance `json:"balance,omitempty"`

	// Identifier of the Participant who owes the balance.
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ParticipantID string `json:"participant_id,omitempty"`
}

Obligation obligation

Obligation swagger:model Obligation

func (*Obligation) MarshalBinary

func (m *Obligation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Obligation) UnmarshalBinary

func (m *Obligation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Obligation) Validate

func (m *Obligation) Validate(formats strfmt.Registry) error

Validate validates this obligation

type Participant

type Participant struct {

	// The business identifier code of each participant
	// Required: true
	// Max Length: 11
	// Min Length: 11
	// Pattern: ^[A-Z]{3}[A-Z]{3}[A-Z2-9]{1}[A-NP-Z0-9]{1}[A-Z0-9]{3}$
	Bic *string `json:"bic" bson:"bic"`

	// Participant's country of residence, country code in ISO 3166-1 format
	// Required: true
	// Max Length: 3
	// Min Length: 3
	CountryCode *string `json:"country_code" bson:"country_code"`

	// The participant id for the participant
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ID *string `json:"id" bson:"id"`

	// The ledger address belonging to the issuing account.
	IssuingAccount string `json:"issuing_account,omitempty" bson:"issuing_account"`

	// Accounts
	OperatingAccounts []*Account `json:"operating_accounts" bson:"operating_accounts"`

	// The Role of this registered participant, it can be MM for Market Maker and IS for Issuer or anchor
	// Required: true
	// Max Length: 2
	// Min Length: 2
	// Enum: [MM IS]
	Role *string `json:"role" bson:"role"`

	// Participant active status on WW network, inactive, active, suspended
	Status string `json:"status,omitempty" bson:"status"`
}

Participant participant

Participant swagger:model Participant

func (*Participant) MarshalBinary

func (m *Participant) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Participant) UnmarshalBinary

func (m *Participant) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Participant) Validate

func (m *Participant) Validate(formats strfmt.Registry) error

Validate validates this participant

type ParticipantStatus

type ParticipantStatus struct {

	// Participant active status on WW network, inactive, active, suspended
	// Required: true
	// Enum: [inactive active suspended]
	Status *string `json:"status"`
}

ParticipantStatus participantStatus

ParticipantStatus swagger:model ParticipantStatus

func (*ParticipantStatus) MarshalBinary

func (m *ParticipantStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ParticipantStatus) UnmarshalBinary

func (m *ParticipantStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ParticipantStatus) Validate

func (m *ParticipantStatus) Validate(formats strfmt.Registry) error

Validate validates this participant status

type PayloadWithSignature

type PayloadWithSignature struct {

	// Signed ISO 20022 message.
	// Required: true
	// Format: byte
	PayloadWithSignature *strfmt.Base64 `json:"payload_with_signature"`
}

PayloadWithSignature payloadWithSignature

PayloadWithSignature swagger:model PayloadWithSignature

func (*PayloadWithSignature) MarshalBinary

func (m *PayloadWithSignature) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayloadWithSignature) UnmarshalBinary

func (m *PayloadWithSignature) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayloadWithSignature) Validate

func (m *PayloadWithSignature) Validate(formats strfmt.Registry) error

Validate validates this payload with signature

type PaymentActor

type PaymentActor struct {

	// customer
	Customer *PaymentAddress `json:"customer,omitempty"`

	// institution
	// Required: true
	Institution *FinancialInstitutionDefinition `json:"institution"`

	// payout location
	PayoutLocation *PayoutLocation `json:"payout_location,omitempty"`
}

PaymentActor actor

Actor swagger:model PaymentActor

func (*PaymentActor) MarshalBinary

func (m *PaymentActor) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentActor) UnmarshalBinary

func (m *PaymentActor) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentActor) Validate

func (m *PaymentActor) Validate(formats strfmt.Registry) error

Validate validates this payment actor

type PaymentAddress

type PaymentAddress struct {

	// account
	// Required: true
	Account *AccountCustomer `json:"account"`

	// Account identifier for the actor involved in a payment.
	// Required: true
	ID *string `json:"id"`

	// location address
	LocationAddress *Address `json:"location_address,omitempty"`

	// Country code of the location.
	// Required: true
	Name *string `json:"name"`
}

PaymentAddress customer

Customer swagger:model PaymentAddress

func (*PaymentAddress) MarshalBinary

func (m *PaymentAddress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentAddress) UnmarshalBinary

func (m *PaymentAddress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentAddress) Validate

func (m *PaymentAddress) Validate(formats strfmt.Registry) error

Validate validates this payment address

type PaymentLogRecord

type PaymentLogRecord struct {

	// the client end-to-end-id for this payment
	// Required: true
	EndToEndID *string `json:"end-to-end-id"`

	// fitoficct memo data
	FitoficctMemoData *PaymentLogRecordFitoficctMemoData `json:"fitoficct_memo_data,omitempty"`

	// the status of this payment
	// Required: true
	PaymentStatus *string `json:"payment_status"`

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

PaymentLogRecord paymentLogRecord

FI to FI CCT payment log record for reporting swagger:model PaymentLogRecord

func (*PaymentLogRecord) MarshalBinary

func (m *PaymentLogRecord) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentLogRecord) UnmarshalBinary

func (m *PaymentLogRecord) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentLogRecord) Validate

func (m *PaymentLogRecord) Validate(formats strfmt.Registry) error

Validate validates this payment log record

type PaymentLogRecordFitoficctMemoData

type PaymentLogRecordFitoficctMemoData struct {

	// The hash value of the FI to FI CCT Pii Data
	// Required: true
	FitoficctPiiHash *string `json:"fitoficct_pii_hash" bson:"fitoficct_pii_hash"`

	// fitoficctnonpiidata
	// Required: true
	Fitoficctnonpiidata *FitoFICCTNonPiiData `json:"fitoficctnonpiidata"`

	// Unique autogenerate ID for mongoDB primary key
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ID string `json:"id,omitempty" bson:"_id"`

	// This is the message name of the transaction request
	// Required: true
	MessageName *string `json:"message_name" bson:"message_name"`

	// This is the message type of the transaction request
	// Required: true
	MessageType *string `json:"message_type" bson:"message_type"`

	// The participant id of the OFI (payment sender)
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	OfiID *string `json:"ofi_id" bson:"ofi_domain"`

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

	// This is the unique id for this transaction generated by the distributed ledger (but not in txn memo hash)
	TransactionIdentifier []string `json:"transaction_identifier" bson:"transaction_identifier"`

	// This would capture the new status of a transaction while transaction travel through payment flow.
	// Required: true
	TransactionStatus []*TransactionReceipt `json:"transaction_status" bson:"transaction_status"`
}

PaymentLogRecordFitoficctMemoData fitoFICCTMemoData

FI to FI CCT Memo Data - the hash value of this will be stored in the transaction memo field swagger:model paymentLogRecordFitoficctMemoData

func (*PaymentLogRecordFitoficctMemoData) MarshalBinary

func (m *PaymentLogRecordFitoficctMemoData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PaymentLogRecordFitoficctMemoData) UnmarshalBinary

func (m *PaymentLogRecordFitoficctMemoData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PaymentLogRecordFitoficctMemoData) Validate

Validate validates this payment log record fitoficct memo data

type PayoutLocation

type PayoutLocation struct {

	// address
	Address *Address `json:"address,omitempty"`

	// category
	// Required: true
	Category *PayoutLocationCategory `json:"category"`

	// The currency accepted.
	// Required: true
	CurrenciesAccepted []string `json:"currencies_accepted" bson:"currencies_accepted"`

	// geo
	// Required: true
	Geo *Geo `json:"geo"`

	// The unique identifier of the location.
	ID string `json:"id,omitempty"`

	// An image of the item. This can be a URL or a fully described ImageObject.
	// Required: true
	Image *string `json:"image"`

	// The financial institute that this location belongs to.
	// Required: true
	MemberOf []string `json:"member_of" bson:"member_of"`

	// The name of the location.
	// Required: true
	Name *string `json:"name"`

	// The opening hours of the location.
	// Required: true
	OpeningHours []*PayoutLocationOpeningHour `json:"opening_hours" bson:"opening_hours"`

	// The collection of identifiers for locations which belong to the location - these can include areas, and points.
	//
	// Required: true
	PayoutChild []string `json:"payout_child" bson:"payout_child"`

	// The collection of identifiers for the parents of the locations - it can be only areas.
	//
	// Required: true
	PayoutParent []string `json:"payout_parent" bson:"payout_parent"`

	// Optional routing information, also known as BIC (bank id code).
	RoutingNumber string `json:"routing_number,omitempty" bson:"routing_number"`

	// The phone number of the location.
	// Required: true
	Telephone *string `json:"telephone"`

	// The type of location. Options include: "Bank", "Non-Bank Financial Institution", "Mobile Network Operator", or "Other".
	//
	// Required: true
	// Enum: [Bank Non-Bank Financial Institution Mobile Network Operator Other]
	Type *string `json:"type"`

	// The URL of the location.
	// Required: true
	URL *string `json:"url"`
}

PayoutLocation payoutLocation

Details of each payout location. Based on https://schema.org/LocalBusiness swagger:model PayoutLocation

func (*PayoutLocation) MarshalBinary

func (m *PayoutLocation) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayoutLocation) UnmarshalBinary

func (m *PayoutLocation) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayoutLocation) Validate

func (m *PayoutLocation) Validate(formats strfmt.Registry) error

Validate validates this payout location

type PayoutLocationCategory

type PayoutLocationCategory struct {

	// name of the category
	// Required: true
	// Enum: [delivery cash_pickup agency_pickup mobile bank_account]
	Name *string `json:"name"`

	// offer list of the category
	// Required: true
	Options []*PayoutLocationOption `json:"options"`
}

PayoutLocationCategory payoutLocationCategory

Details of each payout location offer category. Based on https://schema.org/hasOfferCatalog swagger:model PayoutLocationCategory

func (*PayoutLocationCategory) MarshalBinary

func (m *PayoutLocationCategory) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayoutLocationCategory) UnmarshalBinary

func (m *PayoutLocationCategory) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayoutLocationCategory) Validate

func (m *PayoutLocationCategory) Validate(formats strfmt.Registry) error

Validate validates this payout location category

type PayoutLocationOpeningHour

type PayoutLocationOpeningHour struct {

	// The closing hour of the payout location on the given day(s) of the week
	// Required: true
	Closes *string `json:"closes"`

	// The day of the week for which these opening hours are valid
	// Required: true
	DayOfWeek []string `json:"day_of_week" bson:"day_of_week"`

	// The opening hour of the payout location on the given day(s) of the week
	// Required: true
	Opens *string `json:"opens"`
}

PayoutLocationOpeningHour payoutLocationOpeningHours

The opening hours of each payout location. Based on https://schema.org/OpeningHoursSpecification swagger:model PayoutLocationOpeningHour

func (*PayoutLocationOpeningHour) MarshalBinary

func (m *PayoutLocationOpeningHour) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayoutLocationOpeningHour) UnmarshalBinary

func (m *PayoutLocationOpeningHour) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayoutLocationOpeningHour) Validate

func (m *PayoutLocationOpeningHour) Validate(formats strfmt.Registry) error

Validate validates this payout location opening hour

type PayoutLocationOption

type PayoutLocationOption struct {

	// name of the service
	// Required: true
	Description *string `json:"description"`

	// service detail
	// Required: true
	Terms *string `json:"terms" bson:"terms"`
}

PayoutLocationOption payoutLocationOption

Details of each payout location offer. Based on https://schema.org/hasOfferCatalog swagger:model PayoutLocationOption

func (*PayoutLocationOption) MarshalBinary

func (m *PayoutLocationOption) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayoutLocationOption) UnmarshalBinary

func (m *PayoutLocationOption) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayoutLocationOption) Validate

func (m *PayoutLocationOption) Validate(formats strfmt.Registry) error

Validate validates this payout location option

type PayoutLocationUpdateRequest

type PayoutLocationUpdateRequest struct {

	// The identifier of the payout location
	// Required: true
	ID *string `json:"id"`

	// updated payload
	// Required: true
	UpdatedPayload *PayoutLocation `json:"updated_payload"`
}

PayoutLocationUpdateRequest payoutLocationUpdateRequest

List of updated payout location attributes. Based on https://schema.org/LocalBusiness swagger:model PayoutLocationUpdateRequest

func (*PayoutLocationUpdateRequest) MarshalBinary

func (m *PayoutLocationUpdateRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PayoutLocationUpdateRequest) UnmarshalBinary

func (m *PayoutLocationUpdateRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PayoutLocationUpdateRequest) Validate

func (m *PayoutLocationUpdateRequest) Validate(formats strfmt.Registry) error

Validate validates this payout location update request

type Quote

type Quote struct {

	// rfi operating or issuing account to receive source asset
	// Required: true
	AccountNameReceive *string `json:"account_name_receive"`

	// rfi operating or issuing account to send back target asset
	// Required: true
	AccountNameSend *string `json:"account_name_send"`

	// The source-asset price of the target asset
	// Required: true
	ExchangeRate *decimal.Decimal `json:"exchange_rate"`

	// Maximum units for which this quote is valid
	// Required: true
	LimitMax *decimal.Decimal `json:"limit_max"`

	// Minimum units for which this quote is valid
	LimitMin *decimal.Decimal `json:"limit_min,omitempty"`

	// Unique id for this quote as set by the quote service
	// Required: true
	QuoteID *string `json:"quote_id"`

	// quote request
	// Required: true
	QuoteRequest *QuoteRequest `json:"quote_request"`

	// 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"`

	// End-time for this quote to be valid.
	// Required: true
	TimeExpire *int64 `json:"time_expire"`

	// Start time for this quote to be valid.
	// Required: true
	TimeStart *int64 `json:"time_start"`
}

Quote quote

Quote swagger:model Quote

func (*Quote) MarshalBinary

func (m *Quote) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Quote) UnmarshalBinary

func (m *Quote) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Quote) Validate

func (m *Quote) Validate(formats strfmt.Registry) error

Validate validates this quote

type QuoteEnvelope

type QuoteEnvelope struct {

	// base64 encoded [quote](??base_url??/docs/??version??/api/participant-client-api?jump=model_quote) object
	// Required: true
	Quote *string `json:"quote"`

	// base64 encoded quote object signature
	// Required: true
	Signature *string `json:"signature"`
}

QuoteEnvelope quoteEnvelope

Quote Envelope swagger:model QuoteEnvelope

func (*QuoteEnvelope) MarshalBinary

func (m *QuoteEnvelope) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteEnvelope) UnmarshalBinary

func (m *QuoteEnvelope) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteEnvelope) Validate

func (m *QuoteEnvelope) Validate(formats strfmt.Registry) error

Validate validates this quote envelope

type QuoteFilter

type QuoteFilter struct {

	// This one's special, so be careful! If you set this to true, it will override all other filters and delete all your quotes. Only used for delete quotes
	DeleteAllQuotes *bool `json:"delete_all_quotes,omitempty"`

	// exchange rate
	ExchangeRate *Comparison `json:"exchange_rate,omitempty"`

	// Filter by requestor Participant's identifier.
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	OfiID *string `json:"ofi_id,omitempty"`

	// Filter by Participant's identifier that provided the quote.
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	RfiID *string `json:"rfi_id,omitempty"`

	// source asset
	SourceAsset *Asset `json:"source_asset,omitempty"`

	// status
	Status *Comparison `json:"status,omitempty"`

	// target asset
	TargetAsset *Asset `json:"target_asset,omitempty"`

	// time expire rfi
	TimeExpireRfi *Comparison `json:"time_expire_rfi,omitempty"`
}

QuoteFilter quoteFilter

A set of options you can supply to filter the results of quotes you receive from the /quotes endpoint.

swagger:model QuoteFilter

func (*QuoteFilter) MarshalBinary

func (m *QuoteFilter) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteFilter) UnmarshalBinary

func (m *QuoteFilter) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteFilter) Validate

func (m *QuoteFilter) Validate(formats strfmt.Registry) error

Validate validates this quote filter

type QuoteRequest

type QuoteRequest struct {

	// Maximum units for which this quote is valid
	// Required: true
	LimitMax *decimal.Decimal `json:"limit_max"`

	// Minimum units for which this quote is valid
	LimitMin *decimal.Decimal `json:"limit_min,omitempty"`

	// 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"`

	// source asset
	SourceAsset *Asset `json:"source_asset,omitempty"`

	// target asset
	TargetAsset *Asset `json:"target_asset,omitempty"`

	// End-time for this quote request to be valid
	// Required: true
	TimeExpire *int64 `json:"time_expire"`
}

QuoteRequest quoteRequest

Quote Request swagger:model QuoteRequest

func (*QuoteRequest) MarshalBinary

func (m *QuoteRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteRequest) UnmarshalBinary

func (m *QuoteRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteRequest) Validate

func (m *QuoteRequest) Validate(formats strfmt.Registry) error

Validate validates this quote request

type QuoteRequestNotification

type QuoteRequestNotification struct {

	// Unique id for this quote as set by the quote service
	// Required: true
	QuoteID *string `json:"quote_id"`

	// quote request
	// Required: true
	QuoteRequest *QuoteRequest `json:"quote_request"`
}

QuoteRequestNotification quoteRequestNotification

Quote Request swagger:model QuoteRequestNotification

func (*QuoteRequestNotification) MarshalBinary

func (m *QuoteRequestNotification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteRequestNotification) UnmarshalBinary

func (m *QuoteRequestNotification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteRequestNotification) Validate

func (m *QuoteRequestNotification) Validate(formats strfmt.Registry) error

Validate validates this quote request notification

type QuoteRequestReceipt

type QuoteRequestReceipt struct {

	// Unique id for the original quote request as set by the quote giver.
	// Required: true
	RequestID *string `json:"request_id"`

	// The timestamp when the quote request happened.
	// Required: true
	TimeRequest *int64 `json:"time_request"`
}

QuoteRequestReceipt quoteRequestReceipt

Quote Receipt swagger:model quoteRequestReceipt

func (*QuoteRequestReceipt) MarshalBinary

func (m *QuoteRequestReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteRequestReceipt) UnmarshalBinary

func (m *QuoteRequestReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteRequestReceipt) Validate

func (m *QuoteRequestReceipt) Validate(formats strfmt.Registry) error

Validate validates this quote request receipt

type QuoteStatus

type QuoteStatus struct {

	// quote id for this quote as set by the quote giver
	// Required: true
	QuoteID *string `json:"quote_id"`

	// quote response
	QuoteResponse *Quote `json:"quote_response,omitempty"`

	// request id for this quote as set by the quote service
	RequestID string `json:"request_id,omitempty"`

	// 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"`

	// quote status of a quote request [1 = pending, 2 = updated,3 = executing 4 = executed, 98 = failed, 99 = cancelled]
	// Required: true
	Status *float64 `json:"status"`

	// Time when RFI response to the quote.
	TimeQuote int64 `json:"time_quote,omitempty"`

	// Request time for this quote request.
	TimeRequest int64 `json:"time_request,omitempty"`
}

QuoteStatus quoteStatus

Quote Status swagger:model QuoteStatus

func (*QuoteStatus) MarshalBinary

func (m *QuoteStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*QuoteStatus) UnmarshalBinary

func (m *QuoteStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*QuoteStatus) Validate

func (m *QuoteStatus) Validate(formats strfmt.Registry) error

Validate validates this quote status

type Receive

type Receive struct {

	// The operating or issuing account name where the payment was received.
	//
	// Required: true
	AccountName *string `json:"account_name"`

	// The unique identifier for the compliance check done prior to this payment.
	//
	// Required: true
	TransactionID *string `json:"transaction_id"`

	// Optional info about the transaction.
	//
	TransactionMemo string `json:"transaction_memo,omitempty"`

	// Cursor location of this payment on the ledger.
	// Required: true
	TransactionReference *string `json:"transaction_reference"`
}

Receive receive

Receive swagger:model Receive

func (*Receive) MarshalBinary

func (m *Receive) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Receive) UnmarshalBinary

func (m *Receive) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Receive) Validate

func (m *Receive) Validate(formats strfmt.Registry) error

Validate validates this receive

type RegisterAnchorRequest

type RegisterAnchorRequest struct {

	// The stellar address of the issuing account of the anchor, should have ibm admin account as signatory
	// Required: true
	Address *string `json:"address"`
}

RegisterAnchorRequest registerAnchorRequest

register anchor id on WW swagger:model RegisterAnchorRequest

func (*RegisterAnchorRequest) MarshalBinary

func (m *RegisterAnchorRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RegisterAnchorRequest) UnmarshalBinary

func (m *RegisterAnchorRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RegisterAnchorRequest) Validate

func (m *RegisterAnchorRequest) Validate(formats strfmt.Registry) error

Validate validates this register anchor request

type RequestPayload

type RequestPayload struct {

	// The name of the account with which the payload needs to be signed
	// Required: true
	AccountName *string `json:"account_name"`

	// unsigned request payload to be signed
	// Required: true
	// Format: byte
	Payload *strfmt.Base64 `json:"payload"`
}

RequestPayload requestPayload

requestPayload swagger:model RequestPayload

func (*RequestPayload) MarshalBinary

func (m *RequestPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RequestPayload) UnmarshalBinary

func (m *RequestPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RequestPayload) Validate

func (m *RequestPayload) Validate(formats strfmt.Registry) error

Validate validates this request payload

type Send

type Send struct {

	// The name of the operating or issuing account from which the payment is to be sent
	AccountNameSend string `json:"account_name_send,omitempty"`

	// creditor
	// Required: true
	Creditor *PaymentActor `json:"creditor"`

	// debtor
	// Required: true
	Debtor *PaymentActor `json:"debtor"`

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

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

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

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

Send send

Send swagger:model Send

func (*Send) MarshalBinary

func (m *Send) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Send) UnmarshalBinary

func (m *Send) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Send) Validate

func (m *Send) Validate(formats strfmt.Registry) error

Validate validates this send

type SendPacs

type SendPacs struct {

	// This will be the encoded base 64 format xml message. Sending a transaction request will need to encode a pacs.008 xml message. Reacting on a received transaction request will need to encode an ibwf.001 xml message.
	// Required: true
	Message *string `json:"message"`

	// This will be the type of the xml message. There are three types of message. First, pacs.008 for sending a transaction request. Second, ibwf.001 for reacting on a received transaction request. Finally, any response from the service will be a pacs.002 message.
	// Required: true
	MessageType *string `json:"message_type"`
}

SendPacs sendPacs

Send Pacs format swagger:model SendPacs

func (*SendPacs) MarshalBinary

func (m *SendPacs) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SendPacs) UnmarshalBinary

func (m *SendPacs) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SendPacs) Validate

func (m *SendPacs) Validate(formats strfmt.Registry) error

Validate validates this send pacs

type Signature

type Signature struct {

	// Transaction signed by Participant.
	// Required: true
	// Format: byte
	TransactionSigned *strfmt.Base64 `json:"transaction_signed"`
}

Signature signature

signature swagger:model signature

func (*Signature) MarshalBinary

func (m *Signature) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Signature) UnmarshalBinary

func (m *Signature) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Signature) Validate

func (m *Signature) Validate(formats strfmt.Registry) error

Validate validates this signature

type SignedTransaction

type SignedTransaction struct {

	// reference transaction id, same as sent in the request
	TransactionID string `json:"transaction_id,omitempty"`

	// signed transaction envelope which is signed by the participant
	// Required: true
	// Format: byte
	TransactionSigned *strfmt.Base64 `json:"transaction_signed"`
}

SignedTransaction signedTransaction

signedTransaction swagger:model SignedTransaction

func (*SignedTransaction) MarshalBinary

func (m *SignedTransaction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SignedTransaction) UnmarshalBinary

func (m *SignedTransaction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SignedTransaction) Validate

func (m *SignedTransaction) Validate(formats strfmt.Registry) error

Validate validates this signed transaction

type StellarComplianceData

type StellarComplianceData struct {

	// The full text of the attachment. The hash of this attachment is included as a memo in the transaction. The attachment field follows the Stellar Attachment Convention and should contain at least enough information of the sender to allow the receiving FI to do their sanction check.
	// Required: true
	Attachment *string `json:"attachment"`

	// If the caller needs the recipient’s AML info in order to send the payment. Should ALWAYS be set to true
	// Required: true
	NeedInfo *bool `json:"need_info"`

	// The payment address of the customer that is initiating the send. Ex. 100110193832*uk.bank.payments.gftn.io
	// Required: true
	Sender *string `json:"sender"`

	// The transaction that the sender would like to send in XDR format. This transaction is unsigned and it’s sequence number should be equal 0.
	// Required: true
	Tx *string `json:"tx"`
}

StellarComplianceData stellarComplianceData

StellarComplianceData swagger:model StellarComplianceData

func (*StellarComplianceData) MarshalBinary

func (m *StellarComplianceData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StellarComplianceData) UnmarshalBinary

func (m *StellarComplianceData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StellarComplianceData) Validate

func (m *StellarComplianceData) Validate(formats strfmt.Registry) error

Validate validates this stellar compliance data

type StellarComplianceResponse

type StellarComplianceResponse struct {

	// Marshalled JSON of the recipient’s AML information. (only present if info_status is ok)
	DestInfo string `json:"dest_info,omitempty"`

	// If this FI is willing to share AML information or not.
	// Required: true
	InfoStatus *string `json:"info_status"`

	// If this FI is willing to accept this transaction.
	// Required: true
	TxStatus *string `json:"tx_status"`
}

StellarComplianceResponse stellarComplianceResponse

StellarComplianceResponse swagger:model StellarComplianceResponse

func (*StellarComplianceResponse) MarshalBinary

func (m *StellarComplianceResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StellarComplianceResponse) UnmarshalBinary

func (m *StellarComplianceResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StellarComplianceResponse) Validate

func (m *StellarComplianceResponse) Validate(formats strfmt.Registry) error

Validate validates this stellar compliance response

type StrongholdPaymentInstructions

type StrongholdPaymentInstructions struct {

	// amount
	Amount string `json:"amount,omitempty"`

	// a reference hash to refer transaction in anchor's system of record
	PayToReference string `json:"pay_to_reference,omitempty"`

	// address to return back to
	PayToVenueSpecific string `json:"pay_to_venue_specific,omitempty"`
}

StrongholdPaymentInstructions stronghold payment instructions swagger:model StrongholdPaymentInstructions

func (*StrongholdPaymentInstructions) MarshalBinary

func (m *StrongholdPaymentInstructions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrongholdPaymentInstructions) UnmarshalBinary

func (m *StrongholdPaymentInstructions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrongholdPaymentInstructions) Validate

func (m *StrongholdPaymentInstructions) Validate(formats strfmt.Registry) error

Validate validates this stronghold payment instructions

type StrongholdPaymentMethodDetails

type StrongholdPaymentMethodDetails struct {

	// DA amount to be returned
	// Required: true
	Amount *string `json:"amount"`

	// bank account number
	// Required: true
	BankAccountNumber *string `json:"bank_account_number"`

	// bank account type
	// Required: true
	BankAccountType *string `json:"bank_account_type"`

	// name of bank
	// Required: true
	BankName *string `json:"bank_name"`

	// routing number
	// Required: true
	BankRoutingNumber *string `json:"bank_routing_number"`

	// initiator ip
	// Required: true
	InitiatorIP *string `json:"initiator_ip"`
}

StrongholdPaymentMethodDetails strongholdPaymentMethodDetails

strongholdPaymentMethodDetails swagger:model StrongholdPaymentMethodDetails

func (*StrongholdPaymentMethodDetails) MarshalBinary

func (m *StrongholdPaymentMethodDetails) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrongholdPaymentMethodDetails) UnmarshalBinary

func (m *StrongholdPaymentMethodDetails) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrongholdPaymentMethodDetails) Validate

func (m *StrongholdPaymentMethodDetails) Validate(formats strfmt.Registry) error

Validate validates this stronghold payment method details

type StrongholdResponseResult

type StrongholdResponseResult struct {

	// amount
	Amount string `json:"amount,omitempty"`

	// asset ID issued by an anchor
	AssetID string `json:"assetId,omitempty"`

	// customer reference
	CustomerReference string `json:"customerReference,omitempty"`

	// direction
	Direction string `json:"direction,omitempty"`

	// fee
	FeeAmount string `json:"feeAmount,omitempty"`

	// result id
	ID string `json:"id,omitempty"`

	// typically us-ach
	PaymentMethod string `json:"paymentMethod,omitempty"`

	// payment method details
	// Required: true
	PaymentMethodDetails *StrongholdPaymentMethodDetails `json:"paymentMethodDetails"`

	// payment method instructions
	PaymentMethodInstructions *StrongholdPaymentInstructions `json:"paymentMethodInstructions,omitempty"`

	// status
	Status string `json:"status,omitempty"`
}

StrongholdResponseResult strongholdResponseResult

strong hold specification for withdrawal response swagger:model StrongholdResponseResult

func (*StrongholdResponseResult) MarshalBinary

func (m *StrongholdResponseResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrongholdResponseResult) UnmarshalBinary

func (m *StrongholdResponseResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrongholdResponseResult) Validate

func (m *StrongholdResponseResult) Validate(formats strfmt.Registry) error

Validate validates this stronghold response result

type StrongholdWithdrawRequest

type StrongholdWithdrawRequest struct {

	// asset ID issued by an anchor
	// Required: true
	AssetID *string `json:"assetID"`

	// customer reference
	// Required: true
	CustomerReference *string `json:"customerReference"`

	// payment method information typically \"us-ach\"
	// Required: true
	PaymentMethod *string `json:"paymentMethod"`

	// payment method details
	// Required: true
	PaymentMethodDetails *StrongholdPaymentMethodDetails `json:"paymentMethodDetails"`
}

StrongholdWithdrawRequest strongholdWithdrawRequest

strongholdWithdrawRequest swagger:model StrongholdWithdrawRequest

func (*StrongholdWithdrawRequest) MarshalBinary

func (m *StrongholdWithdrawRequest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrongholdWithdrawRequest) UnmarshalBinary

func (m *StrongholdWithdrawRequest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrongholdWithdrawRequest) Validate

func (m *StrongholdWithdrawRequest) Validate(formats strfmt.Registry) error

Validate validates this stronghold withdraw request

type StrongholdWithdrawResponse

type StrongholdWithdrawResponse struct {

	// request Id
	// Required: true
	RequestID *string `json:"requestId"`

	// result
	// Required: true
	Result *StrongholdResponseResult `json:"result"`

	// status code
	// Required: true
	StatusCode *int64 `json:"statusCode"`

	// success
	// Required: true
	Success *bool `json:"success"`

	// timestamp
	// Required: true
	// Format: date-time
	Timestamp *strfmt.DateTime `json:"timestamp"`
}

StrongholdWithdrawResponse strongholdWithdrawResponse

strongholdWithdrawResponse swagger:model StrongholdWithdrawResponse

func (*StrongholdWithdrawResponse) MarshalBinary

func (m *StrongholdWithdrawResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrongholdWithdrawResponse) UnmarshalBinary

func (m *StrongholdWithdrawResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrongholdWithdrawResponse) Validate

func (m *StrongholdWithdrawResponse) Validate(formats strfmt.Registry) error

Validate validates this stronghold withdraw response

type Sweep

type Sweep struct {

	// A name to identify this source account.
	// Required: true
	AccountName *string `json:"account_name"`

	// Amount of the asset.
	// Required: true
	Amount *decimal.Decimal `json:"amount"`

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

Sweep sweep

Sweep swagger:model Sweep

func (*Sweep) MarshalBinary

func (m *Sweep) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Sweep) UnmarshalBinary

func (m *Sweep) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Sweep) Validate

func (m *Sweep) Validate(formats strfmt.Registry) error

Validate validates this sweep

type SweepInstruction

type SweepInstruction []*Sweep

SweepInstruction sweepInstruction

SweepInstruction swagger:model SweepInstruction

func (SweepInstruction) Validate

func (m SweepInstruction) Validate(formats strfmt.Registry) error

Validate validates this sweep instruction

type SweepReceipt

type SweepReceipt struct {

	// Source account balances, after sweeping.
	BalanceResult []*Sweep `json:"balance_result"`

	// Timestamp when the exchange occurred.
	TimeExecuted int64 `json:"time_executed,omitempty"`

	// Transacted hash.
	// Required: true
	TransactionHash *string `json:"transaction_hash"`
}

SweepReceipt SweepReceipt

Sweep Receipt swagger:model SweepReceipt

func (*SweepReceipt) MarshalBinary

func (m *SweepReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SweepReceipt) UnmarshalBinary

func (m *SweepReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SweepReceipt) Validate

func (m *SweepReceipt) Validate(formats strfmt.Registry) error

Validate validates this sweep receipt

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"`

	// assetsettlement
	// Required: true
	Assetsettlement *Asset `json:"assetsettlement"`

	// feecreditor
	// Required: true
	Feecreditor *Fee `json:"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"`
}

TransactionDetails transactionDetails

Transaction Details swagger:model transactionDetails

func (*TransactionDetails) MarshalBinary

func (m *TransactionDetails) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionDetails) UnmarshalBinary

func (m *TransactionDetails) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionDetails) Validate

func (m *TransactionDetails) Validate(formats strfmt.Registry) error

Validate validates this transaction details

type TransactionFees

type TransactionFees struct {

	// The fee amount (always in asset_settlement), should be a float64 number. Gross_settlement amount will be amount_settlement plus the fee.
	// Required: true
	// Multiple Of: 1e-07
	AmountFee *float64 `json:"amount_fee"`

	// Amount (in payout asset) the RFI pays ultimate beneficiary (recipient).
	// Required: true
	// Multiple Of: 1e-07
	AmountPayout *float64 `json:"amount_payout"`

	// Amount (in settlement asset) the OFI transfers to the RFI on the ledger (exclusive of RFI Fees).
	// Required: true
	// Multiple Of: 1e-07
	AmountSettlement *float64 `json:"amount_settlement"`

	// The 3-letter asset identifier of the payment to the ultimate beneficiary (recipient).
	// Required: true
	AssetCodePayout *string `json:"asset_code_payout"`

	// details asset settlement
	// Required: true
	DetailsAssetSettlement *Asset `json:"details_asset_settlement"`

	// details payout location
	DetailsPayoutLocation *PayoutLocation `json:"details_payout_location,omitempty"`

	// a unique id for this fee request
	// Required: true
	RequestID *string `json:"request_id"`
}

TransactionFees transactionFees

Fees related to a transaction, sent back by a Participant (RFI). swagger:model TransactionFees

func (*TransactionFees) MarshalBinary

func (m *TransactionFees) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionFees) UnmarshalBinary

func (m *TransactionFees) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionFees) Validate

func (m *TransactionFees) Validate(formats strfmt.Registry) error

Validate validates this transaction fees

type TransactionReceipt

type TransactionReceipt struct {

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

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

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

TransactionReceipt transactionReceipt

Transaction Receipt swagger:model transactionReceipt

func (*TransactionReceipt) MarshalBinary

func (m *TransactionReceipt) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionReceipt) UnmarshalBinary

func (m *TransactionReceipt) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionReceipt) Validate

func (m *TransactionReceipt) Validate(formats strfmt.Registry) error

Validate validates this transaction receipt

type Trust

type Trust struct {

	// This is account name that is trusting of the asset. Options include "default", "issuing", or another string that identifies another operating account.
	//
	// Required: true
	AccountName *string `json:"account_name"`

	// The 3-letter code identifying the asset being trusted. For a list of assets retrieve all World Wire assets from the [/assets](??base_url??/docs/??version??/api/participant-client-api?jump=path_get__assets) endpoint.
	//
	// Required: true
	AssetCode *string `json:"asset_code"`

	// Generated by requester, a unique ID for this entire trust flow
	EndToEndID string `json:"end_to_end_id,omitempty"`

	// The trust limit for this asset between source and issuer. This parameter is only necessary when the trust permission you are submitting is "request".
	//
	// Minimum: 1
	Limit int64 `json:"limit,omitempty"`

	// When the permission submitted by an OFI is "request", this is the identifier of the RFI who issued the asset. However, when the permission submitted by an RFI is "allow", this is the OFI's identifier (i.e., uk.yourbankintheUK.payments.ibm.com). Make sure you request trust first to the RFI's issuing account, and then also their operating account.
	//
	// Required: true
	// Max Length: 32
	// Min Length: 5
	// Pattern: ^[a-zA-Z0-9-]{5,32}$
	ParticipantID *string `json:"participant_id"`

	// This string identifier represents the level of trust you would like to set with another participant in your trust object. Options are "request", "allow", or "revoke".
	//
	// Required: true
	Permission *string `json:"permission"`
}

Trust trust

Trust swagger:model Trust

func (*Trust) MarshalBinary

func (m *Trust) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Trust) UnmarshalBinary

func (m *Trust) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Trust) Validate

func (m *Trust) Validate(formats strfmt.Registry) error

Validate validates this trust

type TrustReq

type TrustReq struct {

	// account name
	// Required: true
	AccountName *string `json:"account_name" validate:"required"`

	// allow approved by
	AllowApprovedBy string `json:"allowApprovedBy,omitempty" validate:"omitempty"`

	// allow initiated by
	AllowInitiatedBy string `json:"allowInitiatedBy,omitempty" validate:"omitempty"`

	// approval ids
	// Required: true
	ApprovalIds []string `json:"approval_ids" validate:"required"`

	// asset code
	// Required: true
	AssetCode *string `json:"asset_code" validate:"required"`

	// issuer id
	// Required: true
	IssuerID *string `json:"issuer_id" validate:"required"`

	// key
	Key string `json:"key,omitempty" validate:"omitempty"`

	// limit
	// Required: true
	Limit *int64 `json:"limit" validate:"required"`

	// loaded
	Loaded string `json:"loaded,omitempty" validate:"omitempty"`

	// reason rejected
	ReasonRejected string `json:"reason_rejected,omitempty" validate:"omitempty"`

	// reject approved by
	RejectApprovedBy string `json:"rejectApprovedBy,omitempty" validate:"omitempty"`

	// reject initiated by
	RejectInitiatedBy string `json:"rejectInitiatedBy,omitempty" validate:"omitempty"`

	// request approved by
	RequestApprovedBy string `json:"requestApprovedBy,omitempty" validate:"omitempty"`

	// request initiated by
	RequestInitiatedBy string `json:"requestInitiatedBy,omitempty" validate:"omitempty"`

	// requestor id
	// Required: true
	RequestorID *string `json:"requestor_id" validate:"required"`

	// revoke approved by
	RevokeApprovedBy string `json:"revokeApprovedBy,omitempty" validate:"omitempty"`

	// revoke initiated by
	RevokeInitiatedBy string `json:"revokeInitiatedBy,omitempty" validate:"omitempty"`

	// status
	Status string `json:"status,omitempty" validate:"omitempty"`

	// time updated
	// Required: true
	TimeUpdated *int64 `json:"time_updated" validate:"omitempty"`
}

TrustReq TrustRequest swagger:model TrustReq

func (*TrustReq) MarshalBinary

func (m *TrustReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TrustReq) UnmarshalBinary

func (m *TrustReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TrustReq) Validate

func (m *TrustReq) Validate(formats strfmt.Registry) error

Validate validates this trust req

type UserRole

type UserRole struct {

	// email
	Email string `json:"email,omitempty" validate:"omitempty"`

	// role
	// Required: true
	Role *string `json:"role" validate:"required"`

	// user Id
	UserID string `json:"userId,omitempty" validate:"omitempty"`
}

UserRole UserRole swagger:model UserRole

func (*UserRole) MarshalBinary

func (m *UserRole) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UserRole) UnmarshalBinary

func (m *UserRole) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UserRole) Validate

func (m *UserRole) Validate(formats strfmt.Registry) error

Validate validates this user role

type WhitelistReq

type WhitelistReq struct {

	// approval ids
	// Required: true
	ApprovalIds []string `json:"approvalIds" validate:"required"`

	// rejected by
	RejectedBy string `json:"rejectedBy,omitempty" validate:"omitempty"`

	// requested by
	RequestedBy string `json:"requestedBy,omitempty" validate:"omitempty"`

	// status
	Status string `json:"status,omitempty" validate:"omitempty"`

	// time updated
	TimeUpdated int64 `json:"time_updated,omitempty" validate:"omitempty"`

	// whitelisted Id
	// Required: true
	WhitelistedID *string `json:"whitelistedId" validate:"required"`

	// whitelister Id
	// Required: true
	WhitelisterID *string `json:"whitelisterId" validate:"required"`
}

WhitelistReq BlocklistRequest swagger:model WhitelistReq

func (*WhitelistReq) MarshalBinary

func (m *WhitelistReq) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WhitelistReq) UnmarshalBinary

func (m *WhitelistReq) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WhitelistReq) Validate

func (m *WhitelistReq) Validate(formats strfmt.Registry) error

Validate validates this whitelist req

type WorldWireError

type WorldWireError struct {

	// build version string of micro service
	BuildVersion string `json:"build_version,omitempty"`

	// Error code reference.
	Code string `json:"code,omitempty"`

	// Detailed message description about error.
	// Required: true
	Details *string `json:"details"`

	// Short message description about error.
	// Required: true
	Message *string `json:"message"`

	// participant id, same as home domain as set by environment variables
	ParticipantID string `json:"participant_id,omitempty"`

	// name of micro service
	Service string `json:"service,omitempty"`

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

	// Type is for query purposes, it an identifier to assist with troubleshooting where an error came from (eg, containing func name) tells us if it is originating from NotifyWWError vs. NotFound vs. some other spot
	Type string `json:"type,omitempty"`

	// Url of endpoint that failed.
	URL string `json:"url,omitempty"`
}

WorldWireError error

Error swagger:model WorldWireError

func (*WorldWireError) MarshalBinary

func (m *WorldWireError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WorldWireError) UnmarshalBinary

func (m *WorldWireError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WorldWireError) Validate

func (m *WorldWireError) Validate(formats strfmt.Registry) error

Validate validates this world wire error

type WorldWireMessage

type WorldWireMessage struct {

	// build version string of micro service
	BuildVersion string `json:"build_version,omitempty"`

	// Response message in string.
	Msg string `json:"msg,omitempty"`

	// participant id, same as home domain as set by environment variables
	ParticipantID string `json:"participant_id,omitempty"`

	// name of micro service
	Service string `json:"service,omitempty"`

	// The timestamp of the occurance.
	TimeStamp int64 `json:"time_stamp,omitempty"`

	// Url of endpoint that failed.
	URL string `json:"url,omitempty"`
}

WorldWireMessage wwResponse

wwResponse swagger:model WorldWireMessage

func (*WorldWireMessage) MarshalBinary

func (m *WorldWireMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WorldWireMessage) UnmarshalBinary

func (m *WorldWireMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WorldWireMessage) Validate

func (m *WorldWireMessage) Validate(formats strfmt.Registry) error

Validate validates this world wire message

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL