platformsfund

package
v12.2.0 Latest Latest
Warning

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

 Go to latest Published: Sep 10, 2024 License: MIT Imports: 4 Imported by: 0

README

Go API client for platformsfund

The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include actions such as the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.

For more information, refer to our documentation.

Authentication

To connect to the Fund API, you must use basic authentication credentials of your web service user. If you don't have one, please contact the Adyen Support Team. Then use its credentials to authenticate your request, for example:

curl
-U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\
-H \"Content-Type: application/json\" \\
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

The Fund API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

https://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalance

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 6
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit https://support.adyen.com/

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountDetailBalance 

type AccountDetailBalance struct {
	// The code of the account that holds the balance.
	AccountCode   string         `json:"accountCode,omitempty"`
	DetailBalance *DetailBalance `json:"detailBalance,omitempty"`
}

AccountDetailBalance struct for AccountDetailBalance

type AccountHolderBalanceRequest 

type AccountHolderBalanceRequest struct {
	// The code of the Account Holder of which to retrieve the balance.
	AccountHolderCode string `json:"accountHolderCode"`
}

AccountHolderBalanceRequest struct for AccountHolderBalanceRequest

type AccountHolderBalanceResponse 

type AccountHolderBalanceResponse struct {
	// A list of each account and their balances.
	BalancePerAccount *[]AccountDetailBalance `json:"balancePerAccount,omitempty"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode   string         `json:"resultCode,omitempty"`
	TotalBalance *DetailBalance `json:"totalBalance,omitempty"`
}

AccountHolderBalanceResponse struct for AccountHolderBalanceResponse

type AccountHolderTransactionListRequest 

type AccountHolderTransactionListRequest struct {
	// The code of the account holder that owns the account(s) of which retrieve the transaction list.
	AccountHolderCode string `json:"accountHolderCode"`
	// A list of accounts to include in the transaction list. If left blank, the last fifty (50) transactions for all accounts of the account holder will be included.
	TransactionListsPerAccount *[]TransactionListForAccount `json:"transactionListsPerAccount,omitempty"`
	// A list of statuses to include in the transaction list. If left blank, all transactions will be included. >Permitted values: >* `PendingCredit` - a pending balance credit. >* `CreditFailed` - a pending credit failure; the balance will not be credited. >* `Credited` - a credited balance. >* `PendingDebit` - a pending balance debit (e.g., a refund). >* `CreditClosed` - a pending credit closed; the balance will not be credited. >* `CreditSuspended` - a pending credit closed; the balance will not be credited. >* `DebitFailed` - a pending debit failure; the balance will not be debited. >* `Debited` - a debited balance (e.g., a refund). >* `DebitReversedReceived` - a pending refund reversal. >* `DebitedReversed` - a reversed refund. >* `ChargebackReceived` - a received chargeback request. >* `Chargeback` - a processed chargeback. >* `ChargebackReversedReceived` - a pending chargeback reversal. >* `ChargebackReversed` - a reversed chargeback. >* `Converted` - converted. >* `ManualCorrected` - manual booking/adjustment by Adyen. >* `Payout` - a payout. >* `PayoutReversed` - a reversed payout. >* `PendingFundTransfer` - a pending transfer of funds from one account to another. >* `FundTransfer` - a transfer of funds from one account to another.
	TransactionStatuses []string `json:"transactionStatuses,omitempty"`
}

AccountHolderTransactionListRequest struct for AccountHolderTransactionListRequest

type AccountHolderTransactionListResponse 

type AccountHolderTransactionListResponse struct {
	// A list of the transactions.
	AccountTransactionLists *[]AccountTransactionList `json:"accountTransactionLists,omitempty"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

AccountHolderTransactionListResponse struct for AccountHolderTransactionListResponse

type AccountTransactionList 

type AccountTransactionList struct {
	// The code of the account.
	AccountCode string `json:"accountCode,omitempty"`
	// Indicates whether there is a next page of transactions available.
	HasNextPage bool `json:"hasNextPage,omitempty"`
	// The list of transactions.
	Transactions *[]Transaction `json:"transactions,omitempty"`
}

AccountTransactionList struct for AccountTransactionList

type Amount 

type Amount struct {
	// The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
	Currency string `json:"currency"`
	// The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
	Value int64 `json:"value"`
}

Amount struct for Amount

type BankAccountDetail 

type BankAccountDetail struct {
	// The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	AccountNumber string `json:"accountNumber,omitempty"`
	// The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	AccountType string `json:"accountType,omitempty"`
	// The name of the bank account.
	BankAccountName string `json:"bankAccountName,omitempty"`
	// Merchant reference to the bank account.
	BankAccountReference string `json:"bankAccountReference,omitempty"`
	// The unique identifier (UUID) of the Bank Account. >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.  >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.  >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.  >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.
	BankAccountUUID string `json:"bankAccountUUID,omitempty"`
	// The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	BankBicSwift string `json:"bankBicSwift,omitempty"`
	// The city in which the bank branch is located.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	BankCity string `json:"bankCity,omitempty"`
	// The bank code of the banking institution with which the bank account is registered.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	BankCode string `json:"bankCode,omitempty"`
	// The name of the banking institution with which the bank account is held.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	BankName string `json:"bankName,omitempty"`
	// The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	BranchCode string `json:"branchCode,omitempty"`
	// The check code of the bank account.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	CheckCode string `json:"checkCode,omitempty"`
	// The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	CountryCode string `json:"countryCode,omitempty"`
	// The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	CurrencyCode string `json:"currencyCode,omitempty"`
	// The international bank account number. >The IBAN standard is defined in ISO-13616.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	Iban string `json:"iban,omitempty"`
	// The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerCity string `json:"ownerCity,omitempty"`
	// The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerCountryCode string `json:"ownerCountryCode,omitempty"`
	// The date of birth of the bank account owner.
	OwnerDateOfBirth string `json:"ownerDateOfBirth,omitempty"`
	// The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerHouseNumberOrName string `json:"ownerHouseNumberOrName,omitempty"`
	// The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerName string `json:"ownerName,omitempty"`
	// The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerNationality string `json:"ownerNationality,omitempty"`
	// The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerPostalCode string `json:"ownerPostalCode,omitempty"`
	// The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerState string `json:"ownerState,omitempty"`
	// The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	OwnerStreet string `json:"ownerStreet,omitempty"`
	// If set to true, the bank account is a primary account.
	PrimaryAccount bool `json:"primaryAccount,omitempty"`
	// The tax ID number.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	TaxId string `json:"taxId,omitempty"`
	// The URL to be used for bank account verification. This may be generated on bank account creation.  >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements.
	UrlForVerification string `json:"urlForVerification,omitempty"`
}

BankAccountDetail struct for BankAccountDetail

type DetailBalance 

type DetailBalance struct {
	// The list of balances held by the account.
	Balance *[]Amount `json:"balance,omitempty"`
	// The list of on hold balances held by the account.
	OnHoldBalance *[]Amount `json:"onHoldBalance,omitempty"`
	// The list of pending balances held by the account.
	PendingBalance *[]Amount `json:"pendingBalance,omitempty"`
}

DetailBalance struct for DetailBalance

type ErrorFieldType 

type ErrorFieldType struct {
	// The validation error code.
	ErrorCode int32 `json:"errorCode,omitempty"`
	// A description of the validation error.
	ErrorDescription string     `json:"errorDescription,omitempty"`
	FieldType        *FieldType `json:"fieldType,omitempty"`
}

ErrorFieldType struct for ErrorFieldType

type FieldType 

type FieldType struct {
	// The full name of the property.
	Field string `json:"field,omitempty"`
	// The type of the field.
	FieldName string `json:"fieldName,omitempty"`
	// The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
	ShareholderCode string `json:"shareholderCode,omitempty"`
}

FieldType struct for FieldType

type PayoutAccountHolderRequest 

type PayoutAccountHolderRequest struct {
	// The code of the account from which the payout is to be made.
	AccountCode string `json:"accountCode"`
	// The code of the Account Holder who owns the account from which the payout is to be made. The Account Holder is the party to which the payout will be made.
	AccountHolderCode string `json:"accountHolderCode"`
	Amount            Amount `json:"amount"`
	// The unique ID of the Bank Account held by the Account Holder to which the payout is to be made. If left blank, a bank account is automatically selected.
	BankAccountUUID string `json:"bankAccountUUID,omitempty"`
	// A description of the payout. Maximum 35 characters. Allowed: **abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/?:().,'+ \";**
	Description string `json:"description,omitempty"`
	// A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
	MerchantReference string `json:"merchantReference,omitempty"`
	// The unique ID of the payout method held by the Account Holder to which the payout is to be made. If left blank, a payout instrument is automatically selected.
	PayoutMethodCode string `json:"payoutMethodCode,omitempty"`
	// Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.
	PayoutSpeed string `json:"payoutSpeed,omitempty"`
}

PayoutAccountHolderRequest struct for PayoutAccountHolderRequest

type PayoutAccountHolderResponse 

type PayoutAccountHolderResponse struct {
	// The unique ID of the Bank Account to which the payout was made.
	BankAccountUUID string `json:"bankAccountUUID,omitempty"`
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.
	MerchantReference string `json:"merchantReference,omitempty"`
	// Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.
	PayoutSpeed string `json:"payoutSpeed,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

PayoutAccountHolderResponse struct for PayoutAccountHolderResponse

type PlatformsFund 

type PlatformsFund common.Service

PlatformsFund PlatformsFund service Deprecated: Please migrate to the new Adyen For Platforms.

func (PlatformsFund) AccountHolderBalance 

func (a PlatformsFund) AccountHolderBalance(req *AccountHolderBalanceRequest, ctxs ..._context.Context) (AccountHolderBalanceResponse, *_nethttp.Response, error)

PostAccountHolderBalance Retrieve the balance(s) of an account holder. This endpoint is used to retrieve the balance(s) of the accounts of an account holder. An account's balances are on a per-currency basis (i.e., an account may have multiple balances: one per currency).

  • @param request AccountHolderBalanceRequest - reference of AccountHolderBalanceRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccountHolderBalanceResponse

func (PlatformsFund) AccountHolderTransactionList 

func (a PlatformsFund) AccountHolderTransactionList(req *AccountHolderTransactionListRequest, ctxs ..._context.Context) (AccountHolderTransactionListResponse, *_nethttp.Response, error)

PostAccountHolderTransactionList Retrieve a list of transactions. This endpoint is used to retrieve a list of Transactions for an account holder's accounts. The accounts and Transaction Statuses to be included on the list can be specified. Each call will return a maximum of fifty (50) Transactions per account; in order to retrieve the following set of Transactions another call should be made with the 'page' value incremented. Note that Transactions are ordered with most recent first.

  • @param request AccountHolderTransactionListRequest - reference of AccountHolderTransactionListRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccountHolderTransactionListResponse

func (PlatformsFund) PayoutAccountHolder 

func (a PlatformsFund) PayoutAccountHolder(req *PayoutAccountHolderRequest, ctxs ..._context.Context) (PayoutAccountHolderResponse, *_nethttp.Response, error)

PostPayoutAccountHolder Disburse a specified amount from an account to the account holder. This endpoint is used to pay out a specified amount from an account to the bank account of the account's account holder.

  • @param request PayoutAccountHolderRequest - reference of PayoutAccountHolderRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PayoutAccountHolderResponse

func (PlatformsFund) RefundFundsTransfer 

func (a PlatformsFund) RefundFundsTransfer(req *RefundFundsTransferRequest, ctxs ..._context.Context) (RefundFundsTransferResponse, *_nethttp.Response, error)

PostRefundFundsTransfer Make a refund of the existing transfer funds transfer. This endpoint is used to refund funds transferred from one account to another. Both accounts must be in the same marketplace, but can have different account holders.

  • @param request RefundFundsTransferRequest - reference of RefundFundsTransferRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RefundFundsTransferResponse

func (PlatformsFund) RefundNotPaidOutTransfers 

func (a PlatformsFund) RefundNotPaidOutTransfers(req *RefundNotPaidOutTransfersRequest, ctxs ..._context.Context) (RefundNotPaidOutTransfersResponse, *_nethttp.Response, error)

PostRefundNotPaidOutTransfers Refund all transactions of an account since the most recent payout. This endpoint is used to refund all the transactions of an account which have taken place since the most recent payout. This request is on a per-account basis (as opposed to a per-payment basis), so only the portion of the payment which was made to the specified account will be refunded. The commission(s), fee(s), and payment(s) to other account(s), will remain in the accounts to which they were sent as designated by the original payment's split details.

  • @param request RefundNotPaidOutTransfersRequest - reference of RefundNotPaidOutTransfersRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RefundNotPaidOutTransfersResponse

func (PlatformsFund) SetupBeneficiary 

func (a PlatformsFund) SetupBeneficiary(req *SetupBeneficiaryRequest, ctxs ..._context.Context) (SetupBeneficiaryResponse, *_nethttp.Response, error)

PostSetupBeneficiary Designate an account to be the beneficiary of a separate account and transfer the benefactor's current balance to the beneficiary. This endpoint is used to define a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. Note that a series of benefactor/beneficiaries may not exceed four (4) beneficiaries and may not have a cycle in it.

  • @param request SetupBeneficiaryRequest - reference of SetupBeneficiaryRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SetupBeneficiaryResponse

func (PlatformsFund) TransferFunds 

func (a PlatformsFund) TransferFunds(req *TransferFundsRequest, ctxs ..._context.Context) (TransferFundsResponse, *_nethttp.Response, error)

PostTransferFunds Transfer funds from one platform account to another. This endpoint is used to transfer funds from one account to another account. Both accounts must be in the same marketplace, but can have different account holders. The transfer must include a transfer code, which should be determined by the marketplace, in compliance with local regulations.

  • @param request TransferFundsRequest - reference of TransferFundsRequest).
  • @param ctxs ..._context.Context - optional, for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return TransferFundsResponse

type RefundFundsTransferRequest 

type RefundFundsTransferRequest struct {
	Amount Amount `json:"amount"`
	// A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
	MerchantReference string `json:"merchantReference,omitempty"`
	// A PSP reference of the original fund transfer.
	OriginalReference string `json:"originalReference"`
}

RefundFundsTransferRequest struct for RefundFundsTransferRequest

type RefundFundsTransferResponse 

type RefundFundsTransferResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The value supplied by the executing user when initiating the transfer refund; may be used to link multiple transactions.
	MerchantReference string `json:"merchantReference,omitempty"`
	Message           string `json:"message,omitempty"`
	// A PSP reference of the original fund transfer.
	OriginalReference string `json:"originalReference,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

RefundFundsTransferResponse struct for RefundFundsTransferResponse

type RefundNotPaidOutTransfersRequest 

type RefundNotPaidOutTransfersRequest struct {
	// The code of the account from which to perform the refund(s).
	AccountCode string `json:"accountCode"`
	// The code of the Account Holder which owns the account from which to perform the refund(s).
	AccountHolderCode string `json:"accountHolderCode"`
}

RefundNotPaidOutTransfersRequest struct for RefundNotPaidOutTransfersRequest

type RefundNotPaidOutTransfersResponse 

type RefundNotPaidOutTransfersResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

RefundNotPaidOutTransfersResponse struct for RefundNotPaidOutTransfersResponse

type SetupBeneficiaryRequest 

type SetupBeneficiaryRequest struct {
	// The destination account code.
	DestinationAccountCode string `json:"destinationAccountCode"`
	// A value that can be supplied at the discretion of the executing user.
	MerchantReference string `json:"merchantReference,omitempty"`
	// The benefactor account.
	SourceAccountCode string `json:"sourceAccountCode"`
}

SetupBeneficiaryRequest struct for SetupBeneficiaryRequest

type SetupBeneficiaryResponse 

type SetupBeneficiaryResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

SetupBeneficiaryResponse struct for SetupBeneficiaryResponse

type Transaction 

type Transaction struct {
	Amount            *Amount            `json:"amount,omitempty"`
	BankAccountDetail *BankAccountDetail `json:"bankAccountDetail,omitempty"`
	// The merchant reference of a related capture.
	CaptureMerchantReference string `json:"captureMerchantReference,omitempty"`
	// The psp reference of a related capture.
	CapturePspReference string `json:"capturePspReference,omitempty"`
	// The date on which the transaction was performed.
	CreationDate *time.Time `json:"creationDate,omitempty"`
	// A description of the transaction.
	Description string `json:"description,omitempty"`
	// The code of the account to which funds were credited during an outgoing fund transfer.
	DestinationAccountCode string `json:"destinationAccountCode,omitempty"`
	// The psp reference of the related dispute.
	DisputePspReference string `json:"disputePspReference,omitempty"`
	// The reason code of a dispute.
	DisputeReasonCode string `json:"disputeReasonCode,omitempty"`
	// The merchant reference of a transaction.
	MerchantReference string `json:"merchantReference,omitempty"`
	// The psp reference of the related authorisation or transfer.
	PaymentPspReference string `json:"paymentPspReference,omitempty"`
	// The psp reference of the related payout.
	PayoutPspReference string `json:"payoutPspReference,omitempty"`
	// The psp reference of a transaction.
	PspReference string `json:"pspReference,omitempty"`
	// The code of the account from which funds were debited during an incoming fund transfer.
	SourceAccountCode string `json:"sourceAccountCode,omitempty"`
	// The status of the transaction. >Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.
	TransactionStatus string `json:"transactionStatus,omitempty"`
	// The transfer code of the transaction.
	TransferCode string `json:"transferCode,omitempty"`
}

Transaction struct for Transaction

type TransactionListForAccount 

type TransactionListForAccount struct {
	// The account for which to retrieve the transactions.
	AccountCode string `json:"accountCode"`
	// The page of transactions to retrieve. Each page lists fifty (50) transactions.  The most recent transactions are included on page 1.
	Page int32 `json:"page"`
}

TransactionListForAccount struct for TransactionListForAccount

type TransferFundsRequest 

type TransferFundsRequest struct {
	Amount Amount `json:"amount"`
	// The code of the account to which the funds are to be credited. >The state of the Account Holder of this account must be Active.
	DestinationAccountCode string `json:"destinationAccountCode"`
	// A value that can be supplied at the discretion of the executing user in order to link multiple transactions to one another.
	MerchantReference string `json:"merchantReference,omitempty"`
	// The code of the account from which the funds are to be debited. >The state of the Account Holder of this account must be Active and allow payouts.
	SourceAccountCode string `json:"sourceAccountCode"`
	// The code related to the type of transfer being performed. >The permitted codes differ for each platform account and are defined in their service level agreement.
	TransferCode string `json:"transferCode"`
}

TransferFundsRequest struct for TransferFundsRequest

type TransferFundsResponse 

type TransferFundsResponse struct {
	// Contains field validation errors that would prevent requests from being processed.
	InvalidFields *[]ErrorFieldType `json:"invalidFields,omitempty"`
	// The value supplied by the executing user when initiating the transfer; may be used to link multiple transactions.
	MerchantReference string `json:"merchantReference,omitempty"`
	// The reference of a request. Can be used to uniquely identify the request.
	PspReference string `json:"pspReference,omitempty"`
	// The result code.
	ResultCode string `json:"resultCode,omitempty"`
}

TransferFundsResponse struct for TransferFundsResponse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.