Skip to content

Latest commit

 

History

History
174 lines (97 loc) · 8.87 KB

Payload.md

File metadata and controls

174 lines (97 loc) · 8.87 KB

Payload

Properties

Name Type Description Notes
BankConnectionId Pointer to NullableInt64 Identifier of the bank connection in the Access API. Initialized as soon as the Web Form reaches a final status and a bank connection exists in Access. Use this ID to gather Bank Connection data from Access endpoints like, &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/bankConnections/-id-&#39;&gt;Get a bank connection</a>&quot; or &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/accounts&#39;&gt;Get and search all accounts</a>&quot;.<br/>This field is mutually exclusive with <code>paymentId</code> and <code>standingOrderId</code>. [optional]
PaymentId Pointer to NullableInt64 Identifier of the payment in the Access API. Initialized as soon as the Web Form reaches a final status and a payment exists in Access. Use this ID to get Payment initialization data from the Access endpoint, &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/payments&#39;&gt;Get payments</a>&quot;.<br/>This field is mutually exclusive with <code>bankConnectionId</code> and <code>standingOrderId</code>. [optional]
StandingOrderId Pointer to NullableInt64 Identifier of the standing order in the Access API. Initialized as soon as the Web Form reaches a final status and a standing order exists in Access. Use this ID to get Standing Order initialization data from the Access endpoint, &quot;<a target='_blank' href='https://docs.finapi.io/?product&#x3D;access#get-/api/v1/standingOrders&#39;&gt;Get standing orders</a>&quot;.<br/>This field is mutually exclusive with <code>bankConnectionId</code> and <code>paymentId</code>. [optional]
ErrorCode Pointer to NullableString Reason of the web form failure.<br/><strong>NOTE:</strong> This enum can be extended in the future as new cases arise!<br/><br/>Codes can be interpreted as follows:<br/>&bull; <code>ENTITY_EXISTS</code> - Access API rejected the import because of detected bank connection duplication;<br/>&bull; <code>BANK_SERVER_REJECTION</code> - the flow has been terminated on the bank side, e.g., in case of incorrect credentials;<br/>&bull; <code>INTERRUPTED</code> - web form has been reloaded or re-opened on a step where it's not supported;<br/>&bull; <code>INVALID_TOKEN</code> - the given access token expired or became invalid during the flow; <br/>&bull; <code>MANDATOR_MISCONFIGURATION</code> - the mandator is not properly configured on the Access side, e.g., it is still configured to use the old web form, or the scraper interface has been selected by the Web Form 2.0 but using it is not allowed on the mandator level. Please contact our support team (<a href='mailto:[email protected]'>[email protected]</a>) for troubleshooting;<br/>&bull; <code>NO_ACCOUNTS_FOR_TYPE_LIST</code> - in the end of the web form flow there were no accounts of type requested in the API call; <br/>&bull; <code>UNDETERMINED_BANK</code> - the given search criteria resulted in either zero or multiple bank entries;<br/>&bull; <code>UNEXPECTED_ACCESS_RESPONSE</code> - an unexpected response has been received from the Access API - similarly to the <code>INTERNAL_ERROR</code> code, please forward all details to our Customer Support team; <br/>&bull; <code>UNSUPPORTED_FEATURE</code> - Access API rejected the request because the requested feature is not supported, e.g., a payment with the execution date in the future was requested for a bank that does not support it;<br/>&bull; <code>UNSUPPORTED_ORDER</code> - Access API rejected the payment request because the associated account does not have the required capabilities;<br/>&bull; <code>INTERNAL_ERROR</code> - the reason of the failure can not be identified - please forward all the details to our Customer Support team in order to get more info and also help us to eliminate the issue. [optional]

Methods

NewPayload

func NewPayload() *Payload

NewPayload instantiates a new Payload object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewPayloadWithDefaults

func NewPayloadWithDefaults() *Payload

NewPayloadWithDefaults instantiates a new Payload object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetBankConnectionId

func (o *Payload) GetBankConnectionId() int64

GetBankConnectionId returns the BankConnectionId field if non-nil, zero value otherwise.

GetBankConnectionIdOk

func (o *Payload) GetBankConnectionIdOk() (*int64, bool)

GetBankConnectionIdOk returns a tuple with the BankConnectionId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBankConnectionId

func (o *Payload) SetBankConnectionId(v int64)

SetBankConnectionId sets BankConnectionId field to given value.

HasBankConnectionId

func (o *Payload) HasBankConnectionId() bool

HasBankConnectionId returns a boolean if a field has been set.

SetBankConnectionIdNil

func (o *Payload) SetBankConnectionIdNil(b bool)

SetBankConnectionIdNil sets the value for BankConnectionId to be an explicit nil

UnsetBankConnectionId

func (o *Payload) UnsetBankConnectionId()

UnsetBankConnectionId ensures that no value is present for BankConnectionId, not even an explicit nil

GetPaymentId

func (o *Payload) GetPaymentId() int64

GetPaymentId returns the PaymentId field if non-nil, zero value otherwise.

GetPaymentIdOk

func (o *Payload) GetPaymentIdOk() (*int64, bool)

GetPaymentIdOk returns a tuple with the PaymentId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPaymentId

func (o *Payload) SetPaymentId(v int64)

SetPaymentId sets PaymentId field to given value.

HasPaymentId

func (o *Payload) HasPaymentId() bool

HasPaymentId returns a boolean if a field has been set.

SetPaymentIdNil

func (o *Payload) SetPaymentIdNil(b bool)

SetPaymentIdNil sets the value for PaymentId to be an explicit nil

UnsetPaymentId

func (o *Payload) UnsetPaymentId()

UnsetPaymentId ensures that no value is present for PaymentId, not even an explicit nil

GetStandingOrderId

func (o *Payload) GetStandingOrderId() int64

GetStandingOrderId returns the StandingOrderId field if non-nil, zero value otherwise.

GetStandingOrderIdOk

func (o *Payload) GetStandingOrderIdOk() (*int64, bool)

GetStandingOrderIdOk returns a tuple with the StandingOrderId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStandingOrderId

func (o *Payload) SetStandingOrderId(v int64)

SetStandingOrderId sets StandingOrderId field to given value.

HasStandingOrderId

func (o *Payload) HasStandingOrderId() bool

HasStandingOrderId returns a boolean if a field has been set.

SetStandingOrderIdNil

func (o *Payload) SetStandingOrderIdNil(b bool)

SetStandingOrderIdNil sets the value for StandingOrderId to be an explicit nil

UnsetStandingOrderId

func (o *Payload) UnsetStandingOrderId()

UnsetStandingOrderId ensures that no value is present for StandingOrderId, not even an explicit nil

GetErrorCode

func (o *Payload) GetErrorCode() string

GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise.

GetErrorCodeOk

func (o *Payload) GetErrorCodeOk() (*string, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetErrorCode

func (o *Payload) SetErrorCode(v string)

SetErrorCode sets ErrorCode field to given value.

HasErrorCode

func (o *Payload) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

SetErrorCodeNil

func (o *Payload) SetErrorCodeNil(b bool)

SetErrorCodeNil sets the value for ErrorCode to be an explicit nil

UnsetErrorCode

func (o *Payload) UnsetErrorCode()

UnsetErrorCode ensures that no value is present for ErrorCode, not even an explicit nil

[Back to Model list] [Back to API list] [Back to README]