Api

Class PaymentInstrumentApi

java.lang.Object

Api.PaymentInstrumentApi

public class PaymentInstrumentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PaymentInstrumentApi()
PaymentInstrumentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deletePaymentInstrument(String paymentInstrumentId, String profileId) Delete a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	deletePaymentInstrumentAsync(String paymentInstrumentId, String profileId, ApiCallback<Void> callback) Delete a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	deletePaymentInstrumentCall(String paymentInstrumentId, String profileId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deletePaymentInstrument
ApiResponse<Void>	deletePaymentInstrumentWithHttpInfo(String paymentInstrumentId, String profileId) Delete a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
ApiClient	getApiClient()
PostPaymentInstrumentRequest	getPaymentInstrument(String paymentInstrumentId, String profileId, Boolean retrieveBinDetails) Retrieve a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getPaymentInstrumentAsync(String paymentInstrumentId, String profileId, Boolean retrieveBinDetails, ApiCallback<PostPaymentInstrumentRequest> callback) Retrieve a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	getPaymentInstrumentCall(String paymentInstrumentId, String profileId, Boolean retrieveBinDetails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getPaymentInstrument
ApiResponse<PostPaymentInstrumentRequest>	getPaymentInstrumentWithHttpInfo(String paymentInstrumentId, String profileId, Boolean retrieveBinDetails) Retrieve a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
PatchPaymentInstrumentRequest	patchPaymentInstrument(String paymentInstrumentId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, String ifMatch) Update a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	patchPaymentInstrumentAsync(String paymentInstrumentId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, ApiCallback<PatchPaymentInstrumentRequest> callback) Update a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	patchPaymentInstrumentCall(String paymentInstrumentId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for patchPaymentInstrument
ApiResponse<PatchPaymentInstrumentRequest>	patchPaymentInstrumentWithHttpInfo(String paymentInstrumentId, PatchPaymentInstrumentRequest patchPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, String ifMatch) Update a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
PostPaymentInstrumentRequest	postPaymentInstrument(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails) Create a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, ApiCallback<PostPaymentInstrumentRequest> callback) Create a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
okhttp3.Call	postPaymentInstrumentCall(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for postPaymentInstrument
ApiResponse<PostPaymentInstrumentRequest>	postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest, String profileId, Boolean retrieveBinDetails) Create a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentInstrumentApi

public PaymentInstrumentApi()

PaymentInstrumentApi

public PaymentInstrumentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deletePaymentInstrumentCall

public okhttp3.Call deletePaymentInstrumentCall(String paymentInstrumentId,
                                                String profileId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for deletePaymentInstrument

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deletePaymentInstrument

public void deletePaymentInstrument(String paymentInstrumentId,
                                    String profileId)
                             throws ApiException

Delete a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Throws:

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

deletePaymentInstrumentWithHttpInfo

public ApiResponse<Void> deletePaymentInstrumentWithHttpInfo(String paymentInstrumentId,
                                                             String profileId)
                                                      throws ApiException

Delete a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

Returns:

ApiResponse<Void>

Throws:

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

deletePaymentInstrumentAsync

public okhttp3.Call deletePaymentInstrumentAsync(String paymentInstrumentId,
                                                 String profileId,
                                                 ApiCallback<Void> callback)
                                          throws ApiException

Delete a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting a Payment Instrument**<br>Your system can use this API to delete an existing Payment Instrument.<br>Any Instrument Identifiers representing the card number will also be deleted if they are not associated with any other Payment Instruments.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (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

getPaymentInstrumentCall

public okhttp3.Call getPaymentInstrumentCall(String paymentInstrumentId,
                                             String profileId,
                                             Boolean retrieveBinDetails,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for getPaymentInstrument

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getPaymentInstrument

public PostPaymentInstrumentRequest getPaymentInstrument(String paymentInstrumentId,
                                                         String profileId,
                                                         Boolean retrieveBinDetails)
                                                  throws ApiException

Retrieve a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

Returns:

PostPaymentInstrumentRequest

Throws:

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

getPaymentInstrumentWithHttpInfo

public ApiResponse<PostPaymentInstrumentRequest> getPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
                                                                                  String profileId,
                                                                                  Boolean retrieveBinDetails)
                                                                           throws ApiException

Retrieve a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

Returns:

ApiResponse<PostPaymentInstrumentRequest>

Throws:

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

getPaymentInstrumentAsync

public okhttp3.Call getPaymentInstrumentAsync(String paymentInstrumentId,
                                              String profileId,
                                              Boolean retrieveBinDetails,
                                              ApiCallback<PostPaymentInstrumentRequest> callback)
                                       throws ApiException

Retrieve a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving a Payment Instrument**<br>Your system can use this API to retrieve an existing Payment Instrument.<br>To perform a payment with a particular Payment Instrument simply specify the [Payment Instrument Id in the payments request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (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

patchPaymentInstrumentCall

public okhttp3.Call patchPaymentInstrumentCall(String paymentInstrumentId,
                                               PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                               String profileId,
                                               Boolean retrieveBinDetails,
                                               String ifMatch,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for patchPaymentInstrument

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

patchPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

patchPaymentInstrument

public PatchPaymentInstrumentRequest patchPaymentInstrument(String paymentInstrumentId,
                                                            PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                            String profileId,
                                                            Boolean retrieveBinDetails,
                                                            String ifMatch)
                                                     throws ApiException

Update a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

patchPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

PatchPaymentInstrumentRequest

Throws:

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

patchPaymentInstrumentWithHttpInfo

public ApiResponse<PatchPaymentInstrumentRequest> patchPaymentInstrumentWithHttpInfo(String paymentInstrumentId,
                                                                                     PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                                                     String profileId,
                                                                                     Boolean retrieveBinDetails,
                                                                                     String ifMatch)
                                                                              throws ApiException

Update a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

patchPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (optional)

Returns:

ApiResponse<PatchPaymentInstrumentRequest>

Throws:

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

patchPaymentInstrumentAsync

public okhttp3.Call patchPaymentInstrumentAsync(String paymentInstrumentId,
                                                PatchPaymentInstrumentRequest patchPaymentInstrumentRequest,
                                                String profileId,
                                                Boolean retrieveBinDetails,
                                                String ifMatch,
                                                ApiCallback<PatchPaymentInstrumentRequest> callback)
                                         throws ApiException

Update a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating a Payment Instrument**<br>Your system can use this API to update an existing Payment Instrument.

Parameters:

paymentInstrumentId - The Id of a payment instrument. (required)

patchPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

ifMatch - Contains an ETag value from a GET request to make the request conditional. (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

postPaymentInstrumentCall

public okhttp3.Call postPaymentInstrumentCall(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                              String profileId,
                                              Boolean retrieveBinDetails,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException

Build call for postPaymentInstrument

Parameters:

postPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

postPaymentInstrument

public PostPaymentInstrumentRequest postPaymentInstrument(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                                          String profileId,
                                                          Boolean retrieveBinDetails)
                                                   throws ApiException

Create a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**<br><br>**Creating a Payment Instrument**<br>It is recommended you [create a Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Payment Instruments**<br>To perform a payment with a particular Payment Instrument specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

postPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

Returns:

PostPaymentInstrumentRequest

Throws:

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

postPaymentInstrumentWithHttpInfo

public ApiResponse<PostPaymentInstrumentRequest> postPaymentInstrumentWithHttpInfo(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                                                                   String profileId,
                                                                                   Boolean retrieveBinDetails)
                                                                            throws ApiException

Create a Payment Instrument | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**<br><br>**Creating a Payment Instrument**<br>It is recommended you [create a Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Payment Instruments**<br>To perform a payment with a particular Payment Instrument specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

postPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (optional)

Returns:

ApiResponse<PostPaymentInstrumentRequest>

Throws:

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

postPaymentInstrumentAsync

public okhttp3.Call postPaymentInstrumentAsync(PostPaymentInstrumentRequest postPaymentInstrumentRequest,
                                               String profileId,
                                               Boolean retrieveBinDetails,
                                               ApiCallback<PostPaymentInstrumentRequest> callback)
                                        throws ApiException

Create a Payment Instrument (asynchronously) | | | | | --- | --- | --- | |**Standalone Payment Instruments**<br>A Payment Instrument represents tokenized payment information such as expiration date, billing address & card type.<br>A Payment Instrument token does not store the card number. A Payment Instrument is associated with an [Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier) that represents either a payment card number, or in the case of an ACH bank account, the routing and account number.<br>**Standalone Payment Instruments do not belong to a [Customer](#token-management_customer_create-a-customer).**<br><br>**Creating a Payment Instrument**<br>It is recommended you [create a Payment Instrument via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>In Europe: You should perform Payer Authentication alongside the Authorization.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Payment Instruments**<br>To perform a payment with a particular Payment Instrument specify the [Payment Instrument in the payment request](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-customer-payment-instrument-and-shipping-address-token-id_liveconsole-tab-request-body).

Parameters:

postPaymentInstrumentRequest - (required)

profileId - The Id of a profile containing user specific TMS configuration. (optional)

retrieveBinDetails - Retrieve the Bin Details of PAN or network token (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