import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { PatchTransferBankModel } from '../model/patchTransfer'; import { PostTransferBankModel } from '../model/postTransfer'; import { TransferBankModel } from '../model/transfer'; import { TransferListBankModel } from '../model/transferList'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class TransfersService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * Create Transfer * Creates a transfer. ## State | State | Description | |-------|-------------| | storing | The Platform is storing the transfer details in our private store | | reviewing | The Platform is reviewing the transfer for compliance | | pending | The Platform is executing the transfer | | completed | The Platform has successfully completed the transfer | | failed | The Platform was not able to successfully complete the transfer | ## Failure codes | Code | Description | |------|-------------| | amount_too_low | The transfer was rejected due to the amount being too low | | cancelled | The transfer was manually cancelled | | compliance_rejection | The transfer was rejected for compliance reasons | | internal_error | An internal error occurred while processing the transfer, please try again | | invalid_address | The destination address is invalid for transfer | | invalid_balance | There was insufficient balance for all required currencies to complete the transfer | | return_risk_exceeded | The risk of return is too high for this activity to be completed | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | daily_limit_exceeded | The customer is over their daily limits for this activity | | weekly_limit_exceeded | The customer is over their weekly limits for this activity | | monthly_limit_exceeded | The customer is over their monthly limits for this activity | | network_fee_too_low | The transfer was rejected due to the network fee being too low | | non_sufficient_funds | The customer does not have enough funds to complete the transfer | | party_name_invalid | The transfer\'s associated external bank account has an invalid party name | | payment_rail_invalid | The payment rail specified for the transfer is not supported by the external bank account | | payment_request_expired | The payment request expired before it could be completed | | plaid_access_not_granted | See the description from Plaid [here](https://plaid.com/docs/errors/item/#access_not_granted) | | plaid_institution_not_responding | See the description from Plaid [here](https://plaid.com/docs/errors/institution/#institution_not_responding) | | plaid_internal_server_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#internal_server_error-or-plaid-internal-error) | | plaid_item_not_found | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_found) | | plaid_item_not_supported | See the description from Plaid [here](https://plaid.com/docs/errors/item/#item_not_supported) | | plaid_multiple_accounts | Multiple accounts were selected through Plaid Link. | | plaid_no_accounts | See the description from Plaid [here](https://plaid.com/docs/errors/item/#no_accounts) | | plaid_none_balances_error | The transfer was rejected due to an error with the balances retrieved by Plaid | | plaid_unknown_error | See the description from Plaid [here](https://plaid.com/docs/errors/api/#unknown_error) | | refresh_required | The transfer\'s associated external_bank_account needs to be reconnected via Plaid | | invalid_destination | Issues with the destination details (invalid, closed, blocked) | | customer_action_required | Authorization declined or customer action required | | external_vendor_error | Unexpected error occurred with an external vendor or partner service during transfer processing | | reversed | The transfer was reversed | ## Failure codes that will result in a state change for the associated external bank account | Code | Description | |------|-------------| | refresh_required | The transfer was rejected due to the external bank account needing to be refreshed. The external bank account will be put in the state `refresh_required` | | plaid_access_not_granted | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_found | The transfer was rejected due to the external bank account needing to be reconnected via Plaid. The external bank account will be put in the state `deleted` | | plaid_item_not_supported | The transfer was rejected because the account is not supported. A different account should be connected via Plaid. The external bank account will be put in the state `deleted` | | plaid_multiple_accounts | The transfer was rejected because multiple accounts were selected through Plaid Link. Only one account must be selected. The external bank account will be put in the state `deleted` | | plaid_no_accounts | The transfer was rejected because no compatible accounts could be found. The external bank account will be put in the state `deleted` | Required scope: **transfers:execute** * @param postTransferBankModel * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ createTransfer(postTransferBankModel: PostTransferBankModel, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable; createTransfer(postTransferBankModel: PostTransferBankModel, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; createTransfer(postTransferBankModel: PostTransferBankModel, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; /** * Get Transfer * Retrieves a transfer. Required scope: **transfers:read** * @param transferGuid Identifier for the transfer. * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getTransfer(transferGuid: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable; getTransfer(transferGuid: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; getTransfer(transferGuid: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; /** * Get transfers list * Retrieves a listing of transfers. Records are sorted by creation date in descending order. Required scope: **transfers:read** * @param page The page index to retrieve. * @param perPage The number of entities per page to return. * @param guid Comma separated transfer_guids to list transfers for. * @param transferType Comma separated transfer_types to list accounts for. * @param bankGuid Comma separated bank_guids to list transfers for. * @param customerGuid Comma separated customer_guids to list transfers for. * @param accountGuid Comma separated account_guids to list transfers for. * @param state Comma separated states to list transfers for. * @param side Comma separated sides to list transfers for. * @param label Comma separated labels to list transfers for. * @param txnHash Comma separated transaction hashes to list transfers for. * @param createdAtGte Created at start date-time inclusive lower bound, ISO8601 * @param createdAtLt Created at end date-time exclusive upper bound, ISO8601. * @param updatedAtGte Created at start date-time inclusive lower bound, ISO8601 * @param updatedAtLt Created at end date-time exclusive upper bound, ISO8601. * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ listTransfers(page?: string, perPage?: string, guid?: string, transferType?: string, bankGuid?: string, customerGuid?: string, accountGuid?: string, state?: string, side?: string, label?: string, txnHash?: string, createdAtGte?: string, createdAtLt?: string, updatedAtGte?: string, updatedAtLt?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable; listTransfers(page?: string, perPage?: string, guid?: string, transferType?: string, bankGuid?: string, customerGuid?: string, accountGuid?: string, state?: string, side?: string, label?: string, txnHash?: string, createdAtGte?: string, createdAtLt?: string, updatedAtGte?: string, updatedAtLt?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; listTransfers(page?: string, perPage?: string, guid?: string, transferType?: string, bankGuid?: string, customerGuid?: string, accountGuid?: string, state?: string, side?: string, label?: string, txnHash?: string, createdAtGte?: string, createdAtLt?: string, updatedAtGte?: string, updatedAtLt?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; /** * Patch Transfer * Update a transfer. Required scope: **transfers:write** * @param transferGuid Identifier for the transfer. * @param patchTransferBankModel * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ updateTransfer(transferGuid: string, patchTransferBankModel: PatchTransferBankModel, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable; updateTransfer(transferGuid: string, patchTransferBankModel: PatchTransferBankModel, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; updateTransfer(transferGuid: string, patchTransferBankModel: PatchTransferBankModel, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'application/json'; context?: HttpContext; }): Observable>; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵprov: i0.ɵɵInjectableDeclaration; }