Package api

Class InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest

java.lang.Object

api.InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest

Enclosing class:

InstrumentUpdatesApi

public class InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for downloadInstrumentUpdate
File	execute()	Execute downloadInstrumentUpdate request
okhttp3.Call	executeAsync(ApiCallback<File> _callback)	Execute downloadInstrumentUpdate request (asynchronously)
ApiResponse<File>	executeWithHttpInfo()	Execute downloadInstrumentUpdate request with HTTP info returned
InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest	format(String format)	Set format

Methods inherited from class java.lang.Object

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

Method Detail

format

public InstrumentUpdatesApi.APIdownloadInstrumentUpdateRequest format(String format)

Set format

Parameters:

format - Specify the format you'd like to download the response in (JSON is the only other format available for download). (optional)

Returns:

APIdownloadInstrumentUpdateRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for downloadInstrumentUpdate

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

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 -

execute

public File execute()
             throws ApiException

Execute downloadInstrumentUpdate request

Returns:

File

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	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 -

executeWithHttpInfo

public ApiResponse<File> executeWithHttpInfo()
                                      throws ApiException

Execute downloadInstrumentUpdate request with HTTP info returned

Returns:

ApiResponse<File>

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	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 -

executeAsync

public okhttp3.Call executeAsync(ApiCallback<File> _callback)
                          throws ApiException

Execute downloadInstrumentUpdate request (asynchronously)

Parameters:

_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	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 -