Class: CyberSource::InstrumentIdentifierApi
- Inherits:
-
Object
- Object
- CyberSource::InstrumentIdentifierApi
- Defined in:
- lib/cybersource_rest_client/api/instrument_identifier_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ nil
Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Deleting an Instrument Identifier**
Your system can use this API to delete an existing Instrument Identifier.
An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.
You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier). -
#delete_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting an Instrument Identifier**<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
-
#get_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Retrieving an Instrument Identifier**
Your system can use this API to retrieve an Instrument Identifier.
**Note: the actual card data will be masked.**
The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
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).
For more information about Payment Network Tokens see the Developer Guide.
**Payments with Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments. -
#get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {}) ⇒ PaymentInstrumentList
List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**
Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier. -
#get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(PaymentInstrumentList, Fixnum, Hash)>
List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
-
#get_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|&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 Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
-
#initialize(api_client = ApiClient.default, config) ⇒ InstrumentIdentifierApi
constructor
A new instance of InstrumentIdentifierApi.
-
#patch_instrument_identifier(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Updating an Instrument Identifier**
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.
Your system can use this API to update these values. -
#patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating an Instrument Identifier**<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
-
#post_instrument_identifier(post_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Creating an Instrument Identifier**
It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)
In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
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).
For more information about Payment Network Tokens see the Developer Guide.
**Payments with Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments. -
#post_instrument_identifier_enrollment(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ nil
Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Enroll an Instrument Identifier for a Payment Network Token**
Your system can use this API to provision a Network token for an existing Instrument Identifier.
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.
For more information about Payment Network Tokens see the Developer Guide. -
#post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Enroll an Instrument Identifier for a Payment Network Token**<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<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 Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
-
#post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<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 Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
Constructor Details
#initialize(api_client = ApiClient.default, config) ⇒ InstrumentIdentifierApi
Returns a new instance of InstrumentIdentifierApi.
19 20 21 22 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 19 def initialize(api_client = ApiClient.default, config) @api_client = api_client @api_client.set_configuration(config) end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ nil
Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Deleting an Instrument Identifier**
Your system can use this API to delete an existing Instrument Identifier.
An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.
You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
29 30 31 32 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 29 def delete_instrument_identifier(instrument_identifier_id, opts = {}) data, status_code, headers = delete_instrument_identifier_with_http_info(instrument_identifier_id, opts) return data, status_code, headers end |
#delete_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Deleting an Instrument Identifier**<br>Your system can use this API to delete an existing Instrument Identifier.<br>An Instrument Identifier cannot be deleted if it is linked to any Payment Instruments.<br>You can [retrieve all Payment Instruments associated with an Instrument Identifier](#token-management_instrument-identifier_list-payment-instruments-for-an-instrument-identifier).
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 40 def delete_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.delete_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'instrument_identifier_id' is set if @api_client.config.client_side_validation && instrument_identifier_id.nil? fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.delete_instrument_identifier" end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length > 32 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length < 12 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be great than or equal to 12.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be great than or equal to 36.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? # form parameters form_params = {} # http body (model) if 'DELETE' == 'POST' post_body = '{}' else post_body = nil end auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#delete_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#get_instrument_identifier(instrument_identifier_id, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Retrieving an Instrument Identifier**
Your system can use this API to retrieve an Instrument Identifier.
**Note: the actual card data will be masked.**
The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
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).
For more information about Payment Network Tokens see the Developer Guide.
**Payments with Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.
116 117 118 119 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 116 def get_instrument_identifier(instrument_identifier_id, opts = {}) data, status_code, headers = get_instrument_identifier_with_http_info(instrument_identifier_id, opts) return data, status_code, headers end |
#get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {}) ⇒ PaymentInstrumentList
List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing
and account numbers.
The same token Id is returned for a specific card number or bank account & routing number allowing the
Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument)
or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**
Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
206 207 208 209 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 206 def get_instrument_identifier_payment_instruments_list(instrument_identifier_id, opts = {}) data, status_code, headers = get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts) return data, status_code, headers end |
#get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(PaymentInstrumentList, Fixnum, Hash)>
List Payment Instruments for an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 219 def get_instrument_identifier_payment_instruments_list_with_http_info(instrument_identifier_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'instrument_identifier_id' is set if @api_client.config.client_side_validation && instrument_identifier_id.nil? fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list" end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length > 32 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length < 12 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, the character length must be great than or equal to 12.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, the character length must be great than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0 fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstrumentIdentifierApi.get_instrument_identifier_payment_instruments_list, must be greater than or equal to 1.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}/paymentinstruments'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s) # query parameters query_params = {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? # form parameters form_params = {} # http body (model) if 'GET' == 'POST' post_body = '{}' else post_body = nil end auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PaymentInstrumentList') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier_payment_instruments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#get_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Retrieve an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).|&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 Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 127 def get_instrument_identifier_with_http_info(instrument_identifier_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'instrument_identifier_id' is set if @api_client.config.client_side_validation && instrument_identifier_id.nil? fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.get_instrument_identifier" end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length > 32 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length < 12 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be great than or equal to 12.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be great than or equal to 36.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? # form parameters form_params = {} # http body (model) if 'GET' == 'POST' post_body = '{}' else post_body = nil end auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#patch_instrument_identifier(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Updating an Instrument Identifier**
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.
Your system can use this API to update these values.
312 313 314 315 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 312 def patch_instrument_identifier(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) data, status_code, headers = patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts) return data, status_code, headers end |
#patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Update an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Updating an Instrument Identifier**<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.<br>Your system can use this API to update these values.
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 325 def patch_instrument_identifier_with_http_info(instrument_identifier_id, patch_instrument_identifier_request, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.patch_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'instrument_identifier_id' is set if @api_client.config.client_side_validation && instrument_identifier_id.nil? fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.patch_instrument_identifier" end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length > 32 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length < 12 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be great than or equal to 12.' end # verify the required parameter 'patch_instrument_identifier_request' is set if @api_client.config.client_side_validation && patch_instrument_identifier_request.nil? fail ArgumentError, "Missing the required parameter 'patch_instrument_identifier_request' when calling InstrumentIdentifierApi.patch_instrument_identifier" end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be great than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'if_match'].nil? && opts[:'if_match'].to_s.length > 32 fail ArgumentError, 'invalid value for "opts[:"if_match"]" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && !opts[:'if_match'].nil? && opts[:'if_match'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"if_match"]" when calling InstrumentIdentifierApi.patch_instrument_identifier, the character length must be great than or equal to 1.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? header_params[:'if-match'] = opts[:'if_match'] if !opts[:'if_match'].nil? # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(patch_instrument_identifier_request) auth_names = [] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#patch_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#post_instrument_identifier(post_instrument_identifier_request, opts = {}) ⇒ Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier
Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).
**Creating an Instrument Identifier**
It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.
An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)
In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.
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).
For more information about Payment Network Tokens see the Developer Guide.
**Payments with Instrument Identifiers**
To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).
When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.
These values will be added for you to future Merchant Initiated Transaction payments.
411 412 413 414 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 411 def post_instrument_identifier(post_instrument_identifier_request, opts = {}) data, status_code, headers = post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts) return data, status_code, headers end |
#post_instrument_identifier_enrollment(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ nil
Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**
An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.
The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.
An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Enroll an Instrument Identifier for a Payment Network Token**
Your system can use this API to provision a Network token for an existing Instrument Identifier.
Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.
A Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.
For more information about Payment Network Tokens see the Developer Guide.
488 489 490 491 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 488 def post_instrument_identifier_enrollment(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) data, status_code, headers = post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts) return data, status_code, headers end |
#post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Enroll an Instrument Identifier for Payment Network Token | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Enroll an Instrument Identifier for a Payment Network Token**<br>Your system can use this API to provision a Network token for an existing Instrument Identifier.<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 Network token can be [provisioned when creating an Instrument Identifier](#token-management_instrument-identifier_create-an-instrument-identifier_samplerequests-dropdown_create-instrument-identifier-card-enroll-for-network-token_liveconsole-tab-request-body).This will occur automatically when creating a [Customer](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body), [Payment Instrument](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-create-default-payment-instrument-shipping-address-for-existing-customer_liveconsole-tab-request-body) or [Instrument Identifier](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body) via the Payments API.<br>For more information about Payment Network Tokens see the Developer Guide.
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 500 def post_instrument_identifier_enrollment_with_http_info(instrument_identifier_id, post_instrument_identifier_enrollment_request, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.post_instrument_identifier_enrollment ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'instrument_identifier_id' is set if @api_client.config.client_side_validation && instrument_identifier_id.nil? fail ArgumentError, "Missing the required parameter 'instrument_identifier_id' when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment" end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length > 32 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && instrument_identifier_id.to_s.length < 12 fail ArgumentError, 'invalid value for "instrument_identifier_id" when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment, the character length must be great than or equal to 12.' end # verify the required parameter 'post_instrument_identifier_enrollment_request' is set if @api_client.config.client_side_validation && post_instrument_identifier_enrollment_request.nil? fail ArgumentError, "Missing the required parameter 'post_instrument_identifier_enrollment_request' when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment" end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.post_instrument_identifier_enrollment, the character length must be great than or equal to 36.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{instrumentIdentifierId}/enrollment'.sub('{' + 'instrumentIdentifierId' + '}', instrument_identifier_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(post_instrument_identifier_enrollment_request) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier_enrollment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {}) ⇒ Array<(Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier, Fixnum, Hash)>
Create an Instrument Identifier | | | | | — | — | — | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<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 Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the previousTransactionId and originalAuthorizedAmount values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 422 def post_instrument_identifier_with_http_info(post_instrument_identifier_request, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.post_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'post_instrument_identifier_request' is set if @api_client.config.client_side_validation && post_instrument_identifier_request.nil? fail ArgumentError, "Missing the required parameter 'post_instrument_identifier_request' when calling InstrumentIdentifierApi.post_instrument_identifier" end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length > 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.post_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && !opts[:'profile_id'].nil? && opts[:'profile_id'].to_s.length < 36 fail ArgumentError, 'invalid value for "opts[:"profile_id"]" when calling InstrumentIdentifierApi.post_instrument_identifier, the character length must be great than or equal to 36.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil? # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(post_instrument_identifier_request) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Tmsv2customersEmbeddedDefaultPaymentInstrumentEmbeddedInstrumentIdentifier') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#post_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |