Package api

Class InstrumentUpdatesApi

java.lang.Object

api.InstrumentUpdatesApi

public class InstrumentUpdatesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest

Constructor Summary

Constructors

Constructor	Description
InstrumentUpdatesApi()
InstrumentUpdatesApi(FinixClient finixClient)

Method Summary

Modifier and Type	Method	Description
InstrumentUpdate	create(CreateInstrumentUpdateRequest createInstrumentUpdateRequest)	Create Instrument Updates To update the card details of your customers, create an `instrument_updates` resource.
okhttp3.Call	createPaymentInstrumentUpdateAsync(CreateInstrumentUpdateRequest createInstrumentUpdateRequest, ApiCallback<InstrumentUpdate> _callback)	Create Instrument Updates (asynchronously) To update the card details of your customers, create an `instrument_updates` resource.
okhttp3.Call	createPaymentInstrumentUpdateCall(CreateInstrumentUpdateRequest createInstrumentUpdateRequest, ApiCallback _callback)	Build call for createPaymentInstrumentUpdate
ApiResponse<InstrumentUpdate>	createPaymentInstrumentUpdateWithHttpInfo(CreateInstrumentUpdateRequest createInstrumentUpdateRequest)	Create Instrument Updates To update the card details of your customers, create an `instrument_updates` resource.
File	download(String instrumentUpdatesId, DownloadInstrumentUpdateQueryParams downloadInstrumentUpdateQueryParams)	Download Instrument Updates Fetch a previously created `instrument_updates` resource as a CSV.
InstrumentUpdate	get(String instrumentUpdatesId)	Fetch an Instrument Update Fetch a specific `instrument_update` from an `instrument_updates` resource.
String	getCustomBaseUrl()
FinixClient	getFinixClient()
int	getHostIndex()
okhttp3.Call	getInstrumentUpdateAsync(String instrumentUpdatesId, ApiCallback<InstrumentUpdate> _callback)	Fetch an Instrument Update (asynchronously) Fetch a specific `instrument_update` from an `instrument_updates` resource.
okhttp3.Call	getInstrumentUpdateCall(String instrumentUpdatesId, ApiCallback _callback)	Build call for getInstrumentUpdate
ApiResponse<InstrumentUpdate>	getInstrumentUpdateWithHttpInfo(String instrumentUpdatesId)	Fetch an Instrument Update Fetch a specific `instrument_update` from an `instrument_updates` resource.
void	setCustomBaseUrl(String customBaseUrl)
void	setFinixClient(FinixClient finixClient)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InstrumentUpdatesApi

public InstrumentUpdatesApi()

InstrumentUpdatesApi

public InstrumentUpdatesApi(FinixClient finixClient)

Method Details

getFinixClient

public FinixClient getFinixClient()

setFinixClient

public void setFinixClient(FinixClient finixClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createPaymentInstrumentUpdateCall

public okhttp3.Call createPaymentInstrumentUpdateCall(CreateInstrumentUpdateRequest createInstrumentUpdateRequest,
 ApiCallback _callback)
                                               throws ApiException

Build call for createPaymentInstrumentUpdate

Parameters:

createInstrumentUpdateRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

create

public InstrumentUpdate create(CreateInstrumentUpdateRequest createInstrumentUpdateRequest)
                        throws ApiException

Create Instrument Updates To update the card details of your customers, create an `instrument_updates` resource. Include the `Payment Instrument` IDs you want to update in a CSV. For more info, see the guide on using our [Account Updater](//payments/account-updater/).

Parameters:

createInstrumentUpdateRequest - (optional)

Returns:

InstrumentUpdate

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createPaymentInstrumentUpdateWithHttpInfo

public ApiResponse<InstrumentUpdate> createPaymentInstrumentUpdateWithHttpInfo(CreateInstrumentUpdateRequest createInstrumentUpdateRequest)
                                                                        throws ApiException

Create Instrument Updates To update the card details of your customers, create an `instrument_updates` resource. Include the `Payment Instrument` IDs you want to update in a CSV. For more info, see the guide on using our [Account Updater](//payments/account-updater/).

Parameters:

createInstrumentUpdateRequest - (optional)

Returns:

ApiResponse<InstrumentUpdate>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

createPaymentInstrumentUpdateAsync

public okhttp3.Call createPaymentInstrumentUpdateAsync(CreateInstrumentUpdateRequest createInstrumentUpdateRequest,
 ApiCallback<InstrumentUpdate> _callback)
                                                throws ApiException

Create Instrument Updates (asynchronously) To update the card details of your customers, create an `instrument_updates` resource. Include the `Payment Instrument` IDs you want to update in a CSV. For more info, see the guide on using our [Account Updater](//payments/account-updater/).

Parameters:

createInstrumentUpdateRequest - (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
400	Error	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

download

public File download(String instrumentUpdatesId,
 DownloadInstrumentUpdateQueryParams downloadInstrumentUpdateQueryParams)
              throws ApiException

Download Instrument Updates Fetch a previously created `instrument_updates` resource as a CSV. To fetch the `instrument_updates` resource in JSON, add `?format=json` to the request endpoint.

Parameters:

instrumentUpdatesId - The ID of the `instrument_updates` resource. This ID was returned when initially creating the `instrument_updates` object. (required)

Returns:

APIdownloadInstrumentUpdateRequest

Throws:

ApiException

Http Response Details:

Status Code	Description	Response Headers
200	The updated `Payment Instruments` will be returned in the following comma seperated format: payment\\_instrument\\_original, | payment\\_instrument_new, |result --------------------------- | ---------------------- | ----- PIlkNdfZibF8a7Prd2teGB1 | PI3aQGaCM5nDMjqyTXcbUJzR| CARD\\_EXPIRATION_UPDATED PIJPXW0HZ9lpO1nb6sog5DiX | PIdBHpy7BBSxd2z81VdKpVbT | CARD\\_NOT\\_FOUND PI0ovZAS9yfEtgDrZnMaiLvi | PIhXS0jXNTmklyVk91EsohuZ | CONTACT\\_CARDHOLDER PInOrrKY3G1U33hGYTQJ8cIY | | CLOSED\\_ACCOUNT PIlkAOt5kTVhuuxxbmOi9qn | | INVALID\\_CARD PIiRLbbG4i5daypWNzIrq2xD | | NO\\_CHANGE\\_FOUND PIy5llZGt6VxlDqbcTgATqeH | | UNKNOWN	-
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getInstrumentUpdateCall

public okhttp3.Call getInstrumentUpdateCall(String instrumentUpdatesId,
 ApiCallback _callback)
                                     throws ApiException

Build call for getInstrumentUpdate

Parameters:

instrumentUpdatesId - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

get

public InstrumentUpdate get(String instrumentUpdatesId)
                     throws ApiException

Fetch an Instrument Update Fetch a specific `instrument_update` from an `instrument_updates` resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater).

Parameters:

instrumentUpdatesId - (required)

Returns:

InstrumentUpdate

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getInstrumentUpdateWithHttpInfo

public ApiResponse<InstrumentUpdate> getInstrumentUpdateWithHttpInfo(String instrumentUpdatesId)
                                                              throws ApiException

Fetch an Instrument Update Fetch a specific `instrument_update` from an `instrument_updates` resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater).

Parameters:

instrumentUpdatesId - (required)

Returns:

ApiResponse<InstrumentUpdate>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -

getInstrumentUpdateAsync

public okhttp3.Call getInstrumentUpdateAsync(String instrumentUpdatesId,
 ApiCallback<InstrumentUpdate> _callback)
                                      throws ApiException

Fetch an Instrument Update (asynchronously) Fetch a specific `instrument_update` from an `instrument_updates` resource. For more information, see the guide on using our [Account Updater](/guides/payments/account-updater).

Parameters:

instrumentUpdatesId - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single instrument_update object	* finix-apiuser-role - * date - * x-request-id -
401	Authentication information is missing or invalid	* finix-apiuser-role - * date - * x-request-id -
403	Forbidden	* finix-apiuser-role - * date - * x-request-id -
404	Object does not exist	* finix-apiuser-role - * date - * x-request-id -
406	Not Acceptable	* finix-apiuser-role - * date - * x-request-id -