Documentation ¶
Index ¶
- type RECIPIENTS
- type RECIPIENTS_IMPL
- func (me *RECIPIENTS_IMPL) CreateAnticipation(recipientId string, body *models_pkg.RecipientsAnticipationsRequest, ...) (*models_pkg.RecipientsAnticipationsResponse, error)
- func (me *RECIPIENTS_IMPL) CreateRecipient(body *models_pkg.RecipientsRequest, idempotencyKey *string) (*models_pkg.RecipientsResponse1, error)
- func (me *RECIPIENTS_IMPL) CreateTransfer(recipientId string, body *models_pkg.RecipientsTransfersRequest, ...) (*models_pkg.RecipientsTransfersResponse, error)
- func (me *RECIPIENTS_IMPL) CreateWithdraw(recipientId string, body *models_pkg.CreateWithdrawRequest) (*models_pkg.GetWithdrawResponse, error)
- func (me *RECIPIENTS_IMPL) GetAnticipation(recipientId string, anticipationId string) (*models_pkg.RecipientsAnticipationsResponse, error)
- func (me *RECIPIENTS_IMPL) GetAnticipationLimits(recipientId string, timeframe string, paymentDate *time.Time) (*models_pkg.RecipientsAnticipationLimitsResponse, error)
- func (me *RECIPIENTS_IMPL) GetAnticipations(recipientId string, page *int64, size *int64, status *string, ...) (*models_pkg.RecipientsAnticipationsResponse1, error)
- func (me *RECIPIENTS_IMPL) GetBalance(recipientId string) (*models_pkg.RecipientsBalanceResponse, error)
- func (me *RECIPIENTS_IMPL) GetRecipient(recipientId string) (*models_pkg.RecipientsResponse1, error)
- func (me *RECIPIENTS_IMPL) GetRecipientByCode(code string) (*models_pkg.RecipientsCodeResponse, error)
- func (me *RECIPIENTS_IMPL) GetRecipients(page *int64, size *int64) (*models_pkg.RecipientsResponse, error)
- func (me *RECIPIENTS_IMPL) GetTransfer(recipientId string, transferId string) (*models_pkg.RecipientsTransfersResponse, error)
- func (me *RECIPIENTS_IMPL) GetTransfers(recipientId string, page *int64, size *int64, status *string, ...) (*models_pkg.RecipientsTransfersResponse1, error)
- func (me *RECIPIENTS_IMPL) GetWithdrawById(recipientId string, withdrawalId string) (*models_pkg.GetWithdrawResponse, error)
- func (me *RECIPIENTS_IMPL) GetWithdrawals(recipientId string, page *int64, size *int64, status *string, ...) (*models_pkg.ListWithdrawals, error)
- func (me *RECIPIENTS_IMPL) UpdateAutomaticAnticipationSettings(recipientId string, ...) (*models_pkg.RecipientsAutomaticAnticipationSettingsResponse, error)
- func (me *RECIPIENTS_IMPL) UpdateRecipient(recipientId string, body *models_pkg.RecipientsRequest1, ...) (*models_pkg.RecipientsResponse1, error)
- func (me *RECIPIENTS_IMPL) UpdateRecipientDefaultBankAccount(recipientId string, body *models_pkg.RecipientsDefaultBankAccountRequest, ...) (*models_pkg.RecipientsDefaultBankAccountResponse, error)
- func (me *RECIPIENTS_IMPL) UpdateRecipientMetadata(recipientId string, body *models_pkg.RecipientsMetadataRequest, ...) (*models_pkg.RecipientsMetadataResponse, error)
- func (me *RECIPIENTS_IMPL) UpdateRecipientTransferSettings(recipientId string, body *models_pkg.UpdateTransferSettingsRequest, ...) (*models_pkg.RecipientsTransferSettingsResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type RECIPIENTS ¶
type RECIPIENTS interface { UpdateRecipientMetadata(string, *models_pkg.RecipientsMetadataRequest, *string) (*models_pkg.RecipientsMetadataResponse, error) UpdateRecipientTransferSettings(string, *models_pkg.UpdateTransferSettingsRequest, *string) (*models_pkg.RecipientsTransferSettingsResponse, error) GetAnticipation(string, string) (*models_pkg.RecipientsAnticipationsResponse, error) GetRecipients(*int64, *int64) (*models_pkg.RecipientsResponse, error) CreateRecipient(*models_pkg.RecipientsRequest, *string) (*models_pkg.RecipientsResponse1, error) GetBalance(string) (*models_pkg.RecipientsBalanceResponse, error) GetAnticipations(string, *int64, *int64, *string, *string, *time.Time, *time.Time, *time.Time, *time.Time) (*models_pkg.RecipientsAnticipationsResponse1, error) CreateAnticipation(string, *models_pkg.RecipientsAnticipationsRequest, *string) (*models_pkg.RecipientsAnticipationsResponse, error) UpdateRecipientDefaultBankAccount(string, *models_pkg.RecipientsDefaultBankAccountRequest, *string) (*models_pkg.RecipientsDefaultBankAccountResponse, error) GetRecipient(string) (*models_pkg.RecipientsResponse1, error) UpdateRecipient(string, *models_pkg.RecipientsRequest1, *string) (*models_pkg.RecipientsResponse1, error) GetTransfer(string, string) (*models_pkg.RecipientsTransfersResponse, error) GetTransfers(string, *int64, *int64, *string, *time.Time, *time.Time) (*models_pkg.RecipientsTransfersResponse1, error) CreateTransfer(string, *models_pkg.RecipientsTransfersRequest, *string) (*models_pkg.RecipientsTransfersResponse, error) GetAnticipationLimits(string, string, *time.Time) (*models_pkg.RecipientsAnticipationLimitsResponse, error) CreateWithdraw(string, *models_pkg.CreateWithdrawRequest) (*models_pkg.GetWithdrawResponse, error) GetWithdrawals(string, *int64, *int64, *string, *time.Time, *time.Time) (*models_pkg.ListWithdrawals, error) GetWithdrawById(string, string) (*models_pkg.GetWithdrawResponse, error) UpdateAutomaticAnticipationSettings(string, *models_pkg.UpdateAutomaticAnticipationSettingsRequest, *string) (*models_pkg.RecipientsAutomaticAnticipationSettingsResponse, error) GetRecipientByCode(string) (*models_pkg.RecipientsCodeResponse, error) }
* Interface for the RECIPIENTS_IMPL
type RECIPIENTS_IMPL ¶
type RECIPIENTS_IMPL struct {
// contains filtered or unexported fields
}
* Client structure as interface implementation
func NewRECIPIENTS ¶
func NewRECIPIENTS(config configuration_pkg.CONFIGURATION) *RECIPIENTS_IMPL
* Factory for the RECIPIENTS interaface returning RECIPIENTS_IMPL
func (*RECIPIENTS_IMPL) CreateAnticipation ¶
func (me *RECIPIENTS_IMPL) CreateAnticipation( recipientId string, body *models_pkg.RecipientsAnticipationsRequest, idempotencyKey *string) (*models_pkg.RecipientsAnticipationsResponse, error)
*
- Creates an anticipation
- @param string recipientId parameter: Required
- @param *models_pkg.RecipientsAnticipationsRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsAnticipationsResponse response from the API call
func (*RECIPIENTS_IMPL) CreateRecipient ¶
func (me *RECIPIENTS_IMPL) CreateRecipient( body *models_pkg.RecipientsRequest, idempotencyKey *string) (*models_pkg.RecipientsResponse1, error)
*
- Creates a new recipient
- @param *models_pkg.RecipientsRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsResponse1 response from the API call
func (*RECIPIENTS_IMPL) CreateTransfer ¶
func (me *RECIPIENTS_IMPL) CreateTransfer( recipientId string, body *models_pkg.RecipientsTransfersRequest, idempotencyKey *string) (*models_pkg.RecipientsTransfersResponse, error)
*
- Creates a transfer for a recipient
- @param string recipientId parameter: Required
- @param *models_pkg.RecipientsTransfersRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsTransfersResponse response from the API call
func (*RECIPIENTS_IMPL) CreateWithdraw ¶
func (me *RECIPIENTS_IMPL) CreateWithdraw( recipientId string, body *models_pkg.CreateWithdrawRequest) (*models_pkg.GetWithdrawResponse, error)
*
- CreateWithdraw
- @param string recipientId parameter: Required
- @param *models_pkg.CreateWithdrawRequest body parameter: Required
- @return Returns the *models_pkg.GetWithdrawResponse response from the API call
func (*RECIPIENTS_IMPL) GetAnticipation ¶
func (me *RECIPIENTS_IMPL) GetAnticipation( recipientId string, anticipationId string) (*models_pkg.RecipientsAnticipationsResponse, error)
*
- Gets an anticipation
- @param string recipientId parameter: Required
- @param string anticipationId parameter: Required
- @return Returns the *models_pkg.RecipientsAnticipationsResponse response from the API call
func (*RECIPIENTS_IMPL) GetAnticipationLimits ¶
func (me *RECIPIENTS_IMPL) GetAnticipationLimits( recipientId string, timeframe string, paymentDate *time.Time) (*models_pkg.RecipientsAnticipationLimitsResponse, error)
*
- Gets the anticipation limits for a recipient
- @param string recipientId parameter: Required
- @param string timeframe parameter: Required
- @param *time.Time paymentDate parameter: Required
- @return Returns the *models_pkg.RecipientsAnticipationLimitsResponse response from the API call
func (*RECIPIENTS_IMPL) GetAnticipations ¶
func (me *RECIPIENTS_IMPL) GetAnticipations( recipientId string, page *int64, size *int64, status *string, timeframe *string, paymentDateSince *time.Time, paymentDateUntil *time.Time, createdSince *time.Time, createdUntil *time.Time) (*models_pkg.RecipientsAnticipationsResponse1, error)
*
- Retrieves a paginated list of anticipations from a recipient
- @param string recipientId parameter: Required
- @param *int64 page parameter: Optional
- @param *int64 size parameter: Optional
- @param *string status parameter: Optional
- @param *string timeframe parameter: Optional
- @param *time.Time paymentDateSince parameter: Optional
- @param *time.Time paymentDateUntil parameter: Optional
- @param *time.Time createdSince parameter: Optional
- @param *time.Time createdUntil parameter: Optional
- @return Returns the *models_pkg.RecipientsAnticipationsResponse1 response from the API call
func (*RECIPIENTS_IMPL) GetBalance ¶
func (me *RECIPIENTS_IMPL) GetBalance( recipientId string) (*models_pkg.RecipientsBalanceResponse, error)
*
- Get balance information for a recipient
- @param string recipientId parameter: Required
- @return Returns the *models_pkg.RecipientsBalanceResponse response from the API call
func (*RECIPIENTS_IMPL) GetRecipient ¶
func (me *RECIPIENTS_IMPL) GetRecipient( recipientId string) (*models_pkg.RecipientsResponse1, error)
*
- Retrieves recipient information
- @param string recipientId parameter: Required
- @return Returns the *models_pkg.RecipientsResponse1 response from the API call
func (*RECIPIENTS_IMPL) GetRecipientByCode ¶
func (me *RECIPIENTS_IMPL) GetRecipientByCode( code string) (*models_pkg.RecipientsCodeResponse, error)
*
- Retrieves recipient information
- @param string code parameter: Required
- @return Returns the *models_pkg.RecipientsCodeResponse response from the API call
func (*RECIPIENTS_IMPL) GetRecipients ¶
func (me *RECIPIENTS_IMPL) GetRecipients( page *int64, size *int64) (*models_pkg.RecipientsResponse, error)
*
- Retrieves paginated recipients information
- @param *int64 page parameter: Optional
- @param *int64 size parameter: Optional
- @return Returns the *models_pkg.RecipientsResponse response from the API call
func (*RECIPIENTS_IMPL) GetTransfer ¶
func (me *RECIPIENTS_IMPL) GetTransfer( recipientId string, transferId string) (*models_pkg.RecipientsTransfersResponse, error)
*
- Gets a transfer
- @param string recipientId parameter: Required
- @param string transferId parameter: Required
- @return Returns the *models_pkg.RecipientsTransfersResponse response from the API call
func (*RECIPIENTS_IMPL) GetTransfers ¶
func (me *RECIPIENTS_IMPL) GetTransfers( recipientId string, page *int64, size *int64, status *string, createdSince *time.Time, createdUntil *time.Time) (*models_pkg.RecipientsTransfersResponse1, error)
*
- Gets a paginated list of transfers for the recipient
- @param string recipientId parameter: Required
- @param *int64 page parameter: Optional
- @param *int64 size parameter: Optional
- @param *string status parameter: Optional
- @param *time.Time createdSince parameter: Optional
- @param *time.Time createdUntil parameter: Optional
- @return Returns the *models_pkg.RecipientsTransfersResponse1 response from the API call
func (*RECIPIENTS_IMPL) GetWithdrawById ¶
func (me *RECIPIENTS_IMPL) GetWithdrawById( recipientId string, withdrawalId string) (*models_pkg.GetWithdrawResponse, error)
*
- GetWithdrawById
- @param string recipientId parameter: Required
- @param string withdrawalId parameter: Required
- @return Returns the *models_pkg.GetWithdrawResponse response from the API call
func (*RECIPIENTS_IMPL) GetWithdrawals ¶
func (me *RECIPIENTS_IMPL) GetWithdrawals( recipientId string, page *int64, size *int64, status *string, createdSince *time.Time, createdUntil *time.Time) (*models_pkg.ListWithdrawals, error)
*
- Gets a paginated list of transfers for the recipient
- @param string recipientId parameter: Required
- @param *int64 page parameter: Optional
- @param *int64 size parameter: Optional
- @param *string status parameter: Optional
- @param *time.Time createdSince parameter: Optional
- @param *time.Time createdUntil parameter: Optional
- @return Returns the *models_pkg.ListWithdrawals response from the API call
func (*RECIPIENTS_IMPL) UpdateAutomaticAnticipationSettings ¶
func (me *RECIPIENTS_IMPL) UpdateAutomaticAnticipationSettings( recipientId string, body *models_pkg.UpdateAutomaticAnticipationSettingsRequest, idempotencyKey *string) (*models_pkg.RecipientsAutomaticAnticipationSettingsResponse, error)
*
- Updates recipient metadata
- @param string recipientId parameter: Required
- @param *models_pkg.UpdateAutomaticAnticipationSettingsRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsAutomaticAnticipationSettingsResponse response from the API call
func (*RECIPIENTS_IMPL) UpdateRecipient ¶
func (me *RECIPIENTS_IMPL) UpdateRecipient( recipientId string, body *models_pkg.RecipientsRequest1, idempotencyKey *string) (*models_pkg.RecipientsResponse1, error)
*
- Updates a recipient
- @param string recipientId parameter: Required
- @param *models_pkg.RecipientsRequest1 body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsResponse1 response from the API call
func (*RECIPIENTS_IMPL) UpdateRecipientDefaultBankAccount ¶
func (me *RECIPIENTS_IMPL) UpdateRecipientDefaultBankAccount( recipientId string, body *models_pkg.RecipientsDefaultBankAccountRequest, idempotencyKey *string) (*models_pkg.RecipientsDefaultBankAccountResponse, error)
*
- Updates the default bank account from a recipient
- @param string recipientId parameter: Required
- @param *models_pkg.RecipientsDefaultBankAccountRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsDefaultBankAccountResponse response from the API call
func (*RECIPIENTS_IMPL) UpdateRecipientMetadata ¶
func (me *RECIPIENTS_IMPL) UpdateRecipientMetadata( recipientId string, body *models_pkg.RecipientsMetadataRequest, idempotencyKey *string) (*models_pkg.RecipientsMetadataResponse, error)
*
- Updates recipient metadata
- @param string recipientId parameter: Required
- @param *models_pkg.RecipientsMetadataRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsMetadataResponse response from the API call
func (*RECIPIENTS_IMPL) UpdateRecipientTransferSettings ¶
func (me *RECIPIENTS_IMPL) UpdateRecipientTransferSettings( recipientId string, body *models_pkg.UpdateTransferSettingsRequest, idempotencyKey *string) (*models_pkg.RecipientsTransferSettingsResponse, error)
*
- UpdateRecipientTransferSettings
- @param string recipientId parameter: Required
- @param *models_pkg.UpdateTransferSettingsRequest body parameter: Required
- @param *string idempotencyKey parameter: Optional
- @return Returns the *models_pkg.RecipientsTransferSettingsResponse response from the API call
Click to show internal directories.
Click to hide internal directories.