transfers

Documentation

Index

• type Client
  • func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client
  • func (c *Client) InitiateTransferOfFounds(request TransferRequest, idempotencyKey *string) (*TransferResponse, error)
  • func (c *Client) RetrieveTransfer(transferId string) (*TransferDetails, error)
• type TransferDestinationRequest
• type TransferDestinationResponse
• type TransferDetails
• type TransferRequest
• type TransferResponse
• type TransferSourceRequest
• type TransferSourceResponse
• type TransferType

Types

type Client

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

func NewClient

func NewClient(configuration *configuration.Configuration, apiClient client.HttpClient) *Client

func (*Client) InitiateTransferOfFounds

func (c *Client) InitiateTransferOfFounds(request TransferRequest, idempotencyKey *string) (*TransferResponse, error)

func (*Client) RetrieveTransfer

func (c *Client) RetrieveTransfer(transferId string) (*TransferDetails, error)

type TransferDestinationRequest

type TransferDestinationRequest struct {
	Id string `json:"id,omitempty"`
}

Request

type TransferDestinationResponse

type TransferDestinationResponse struct {
	EntityId string `json:"entity_id,omitempty"`
}

Response

type TransferDetails

type TransferDetails struct {
	HttpMetadata common.HttpMetadata
	Id           string                       `json:"id,omitempty"`
	Reference    string                       `json:"reference,omitempty"`
	Status       string                       `json:"status,omitempty"`
	TransferType TransferType                 `json:"transfer_type,omitempty"`
	RequestedOn  *time.Time                   `json:"requested_on,omitempty"`
	ReasonCodes  []string                     `json:"reason_codes,omitempty"`
	Source       *TransferSourceResponse      `json:"source,omitempty"`
	Destination  *TransferDestinationResponse `json:"destination,omitempty"`
	Links        map[string]common.Link       `json:"_links"`
}

Response

type TransferRequest

type TransferRequest struct {
	Reference    string                      `json:"reference,omitempty"`
	TransferType TransferType                `json:"transfer_type,omitempty"`
	Source       *TransferSourceRequest      `json:"source,omitempty"`
	Destination  *TransferDestinationRequest `json:"destination,omitempty"`
}

Request

type TransferResponse

type TransferResponse struct {
	HttpMetadata common.HttpMetadata
	Id           string                 `json:"id,omitempty"`
	Status       string                 `json:"status,omitempty"`
	Links        map[string]common.Link `json:"_links"`
}

Response

type TransferSourceRequest

type TransferSourceRequest struct {
	Id     string `json:"id,omitempty"`
	Amount int64  `json:"amount,omitempty"`
}

Request

type TransferSourceResponse

type TransferSourceResponse struct {
	EntityId string          `json:"entity_id,omitempty"`
	Amount   int64           `json:"amount,omitempty"`
	Currency common.Currency `json:"currency,omitempty"`
}

Response

type TransferType

type TransferType string

const (
	Commission TransferType = "commission"
	Promotion  TransferType = "promotion"
	Refund     TransferType = "refund"
)