citypay_api_client 1.0.3 → 1.1.2

data/docs/AuthReference.md

@@ -2,42 +2,43 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **Integer** | The amount of the transaction in decimal currency format. | [optional] 
-**amount_value** | **String** | The amount of the transaction in integer/request format. | [optional] 
-**atrn** | **String** | A reference number provided by the acquiring services. | [optional] 
-**authcode** | **String** | The authorisation code of the transaction returned by the acquirer or card issuer. | [optional] 
-**batchno** | **String** | A batch number which the transaction has been end of day batched towards. | [optional] 
-**currency** | **String** | The currency of the transaction in ISO 4217 code format. | [optional] 
-**datetime** | **DateTime** | The date and time of the transaction. | [optional] 
-**identifier** | **String** | The identifier of the transaction used to process the transaction. | [optional] 
-**maskedpan** | **String** | A masking of the card number which was used to process the tranasction. | [optional] 
-**merchantid** | **Integer** | The merchant id of the transaction result. | [optional] 
-**result** | **String** | The result of the transaction. | [optional] 
-**trans_status** | **String** | The current status of the transaction through it's lifecycle. | [optional] 
-**trans_type** | **String** | The type of transaction that was processed. | [optional] 
-**transno** | **Integer** | The transaction number of the transaction. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **String** | The amount of the transaction in decimal currency format. | [optional] |
+| **amount_value** | **Integer** | The amount of the transaction in integer/request format. | [optional] |
+| **atrn** | **String** | A reference number provided by the acquiring services. | [optional] |
+| **authcode** | **String** | The authorisation code of the transaction returned by the acquirer or card issuer. | [optional] |
+| **batchno** | **String** | A batch number which the transaction has been end of day batched towards. | [optional] |
+| **currency** | **String** | The currency of the transaction in ISO 4217 code format. | [optional] |
+| **datetime** | **Time** | The date and time of the transaction. | [optional] |
+| **identifier** | **String** | The identifier of the transaction used to process the transaction. | [optional] |
+| **maskedpan** | **String** | A masking of the card number which was used to process the tranasction. | [optional] |
+| **merchantid** | **Integer** | The merchant id of the transaction result. | [optional] |
+| **result** | **String** | The result of the transaction. | [optional] |
+| **trans_status** | **String** | The current status of the transaction through it's lifecycle. | [optional] |
+| **trans_type** | **String** | The type of transaction that was processed. | [optional] |
+| **transno** | **Integer** | The transaction number of the transaction. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AuthReference.new(amount: 3600,
-                                 amount_value: null,
-                                 atrn: null,
-                                 authcode: 001245A,
-                                 batchno: null,
-                                 currency: GBP,
-                                 datetime: 2020-01-02T18:32:28Z,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 maskedpan: 4***********0002,
-                                 merchantid: 11223344,
-                                 result: null,
-                                 trans_status: null,
-                                 trans_type: null,
-                                 transno: 78416)
+instance = CityPayApiClient::AuthReference.new(
+  amount: 20.0,
+  amount_value: 3600,
+  atrn: null,
+  authcode: 001245A,
+  batchno: null,
+  currency: GBP,
+  datetime: 2020-01-02T18:32:28Z,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  maskedpan: 4***********0002,
+  merchantid: 11223344,
+  result: null,
+  trans_status: null,
+  trans_type: null,
+  transno: 78416
+)
 ```
 
-

data/docs/AuthReferences.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**auths** | [**Array<AuthReference>**](AuthReference.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auths** | [**Array<AuthReference>**](AuthReference.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AuthReferences.new(auths: null)
+instance = CityPayApiClient::AuthReferences.new(
+  auths: null
+)
 ```
 
-

data/docs/AuthRequest.md

@@ -2,58 +2,61 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] 
-**amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits. No decimal points are to be included and no divisional characters such as 1,024. The amount should be the total amount required for the transaction. For example with GBP £1,021.95 the amount value is 102195.  | 
-**avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.  `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.  `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.  `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] 
-**bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] 
-**card_holder_name** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] 
-**cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.  | 
-**csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.   Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored. This applies to all entities handling card data. It should also not be used in any hashing process. CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] 
-**csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.  `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.  `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.  `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] 
-**currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] 
-**duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.  `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.  `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.  `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] 
-**expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12.  | 
-**expyear** | **Integer** | The year of expiry of the card.  | 
-**external_mpi** | [**ExternalMPI**](ExternalMPI.md) |  | [optional] 
-**identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 32 to 127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  | 
-**match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.   Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.  `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.  `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.  `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] 
-**mcc6012** | [**MCC6012**](MCC6012.md) |  | [optional] 
-**merchantid** | **Integer** | Identifies the merchant account to perform processing for. | 
-**sdk** | **String** | An optional reference value for the calling client such as a version number i.e. | [optional] 
-**ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] 
-**threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] 
-**trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] 
-**trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **airline_data** | [**AirlineAdvice**](AirlineAdvice.md) |  | [optional] |
+| **amount** | **Integer** | The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195.  |  |
+| **avs_postcode_policy** | **String** | A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation.  | [optional] |
+| **bill_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **cardnumber** | **String** | The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.  |  |
+| **csc** | **String** | The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.  | [optional] |
+| **csc_policy** | **String** | A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation.  | [optional] |
+| **currency** | **String** | The processing currency for the transaction. Will default to the merchant account currency. | [optional] |
+| **duplicate_policy** | **String** | A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass.  | [optional] |
+| **event_management** | [**EventDataModel**](EventDataModel.md) |  | [optional] |
+| **expmonth** | **Integer** | The month of expiry of the card. The month value should be a numerical value between 1 and 12.  |  |
+| **expyear** | **Integer** | The year of expiry of the card.  |  |
+| **external_mpi** | [**ExternalMPI**](ExternalMPI.md) |  | [optional] |
+| **identifier** | **String** | The identifier of the transaction to process. The value should be a valid reference and may be used to perform  post processing actions and to aid in reconciliation of transactions.  The value should be a valid printable string with ASCII character ranges from 0x32 to 0x127.  The identifier is recommended to be distinct for each transaction such as a [random unique identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) this will aid in ensuring each transaction is identifiable.  When transactions are processed they are also checked for duplicate requests. Changing the identifier on a subsequent request will ensure that a transaction is considered as different.  |  |
+| **match_avsa** | **String** | A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation.  | [optional] |
+| **mcc6012** | [**MCC6012**](MCC6012.md) |  | [optional] |
+| **merchantid** | **Integer** | Identifies the merchant account to perform processing for. |  |
+| **name_on_card** | **String** | The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.  | [optional] |
+| **ship_to** | [**ContactDetails**](ContactDetails.md) |  | [optional] |
+| **tag** | **String** | A \"tag\" is a label that you can attach to a payment authorization. Tags can help you group transactions together based on certain criteria, like a work job or a ticket number. They can also assist in filtering transactions when you're generating reports.  Multiple Tags You can add more than one tag to a transaction by separating them with commas.  Limitations There is a maximum limit of 3 tags that can be added to a single transaction. Each tag can be no longer than 20 characters and alphanumeric with no spaces.  Example: Let's say you're a software company and you have different teams working on various projects. When a team makes a purchase or incurs an expense, they can tag the transaction with the project name, the team name, and the type of expense.  Project Name: Project_X Team Name: Team_A Type of Expense: Hardware So, the tag for a transaction might look like: Project_X,Team_A,Hardware  This way, when you're looking at your financial reports, you can easily filter transactions based on these tags to see how much each project or team is spending on different types of expenses.  | [optional] |
+| **threedsecure** | [**ThreeDSecure**](ThreeDSecure.md) |  | [optional] |
+| **trans_info** | **String** | Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id. | [optional] |
+| **trans_type** | **String** | The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AuthRequest.new(airline_data: null,
-                                 amount: 3600,
-                                 avs_postcode_policy: null,
-                                 bill_to: null,
-                                 card_holder_name: null,
-                                 cardnumber: 4000 0000 0000 0002,
-                                 csc: 12,
-                                 csc_policy: null,
-                                 currency: GBP,
-                                 duplicate_policy: null,
-                                 expmonth: 9,
-                                 expyear: 2023,
-                                 external_mpi: null,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 match_avsa: null,
-                                 mcc6012: null,
-                                 merchantid: 11223344,
-                                 sdk: MyClient 1.3.0,
-                                 ship_to: null,
-                                 threedsecure: null,
-                                 trans_info: null,
-                                 trans_type: null)
+instance = CityPayApiClient::AuthRequest.new(
+  airline_data: null,
+  amount: 3600,
+  avs_postcode_policy: null,
+  bill_to: null,
+  cardnumber: 4000 0000 0000 0002,
+  csc: 10,
+  csc_policy: null,
+  currency: GBP,
+  duplicate_policy: null,
+  event_management: null,
+  expmonth: 9,
+  expyear: 2027,
+  external_mpi: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  match_avsa: null,
+  mcc6012: null,
+  merchantid: 11223344,
+  name_on_card: MR NE BODY,
+  ship_to: null,
+  tag: null,
+  threedsecure: null,
+  trans_info: null,
+  trans_type: null
+)
 ```
 
-

data/docs/AuthResponse.md

@@ -2,68 +2,73 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**amount** | **Integer** | The amount of the transaction processed. | [optional] 
-**atrn** | **String** | A reference number provided by the acquirer for a transaction it can be used to cross reference transactions with an Acquirers reporting panel.  | [optional] 
-**atsd** | **String** | Additional Transaction Security Data used for ecommerce transactions to decipher security capabilities and attempts against a transaction. | [optional] 
-**authcode** | **String** | The authorisation code as returned by the card issuer or acquiring bank when a transaction has successfully   been authorised. Authorisation codes contain alphanumeric values. Whilst the code confirms authorisation it   should not be used to determine whether a transaction was successfully processed. For instance an auth code   may be returned when a transaction has been subsequently declined due to a CSC mismatch.  | [optional] 
-**authen_result** | **String** | The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are | Value | Description | |-------|-------------| | Y | Authentication Successful. The Cardholder's password was successfully validated. | | N | Authentication Failed. Customer failed or cancelled authentication, transaction denied. | | A | Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated | | U | Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem |  | [optional] 
-**authorised** | **Boolean** | A boolean definition that indicates that the transaction was authorised. It will return false if the transaction  was declined, rejected or cancelled due to CSC matching failures. Attention should be referenced to the AuthResult and Response code for accurate determination of the result.  | [optional] 
-**avs_result** | **String** | The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline.   | Code | Description |  |------|------------|  | Y | Address and 5 digit post code match |  | M | Street address and Postal codes match for international transaction |  | U | No AVS data available from issuer auth system |  | A | Addres matches, post code does not |  | I | Address information verified for international transaction |  | Z | 5 digit post code matches, Address does not |  | W | 9 digit post code matches, Address does not |  | X | Postcode and address match |  | B | Postal code not verified due to incompatible formats |  | P | Postal codes match. Street address not verified due to to incompatible formats |  | E | AVS Error |  | C | Street address and Postal code not verified due to incompatible formats |  | D | Street address and postal codes match |  |   | No information |  | N | Neither postcode nor address match |  | R | Retry, System unavailble or Timed Out |  | S | AVS Service not supported by issuer or processor |  | G | Issuer does not participate in AVS |  | [optional] 
-**bin_commercial** | **Boolean** | Determines whether the bin range was found to be a commercial or business card. | [optional] 
-**bin_debit** | **Boolean** | Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card. | [optional] 
-**bin_description** | **String** | A description of the bin range found for the card. | [optional] 
-**cavv** | **String** | The cardholder authentication verification value which can be returned for verification purposes of the authenticated  transaction for dispute realisation.  | [optional] 
-**context** | **String** | The context which processed the transaction, can be used for support purposes to trace transactions. | [optional] 
-**csc_result** | **String** | The CSC rseult codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline.   | Code | Description |  |------|------------|  |   | No information |  | M | Card verification data matches |  | N | Card verification data was checked but did not match |  | P | Card verification was not processed |  | S | The card verification data should be on the card but the merchant indicates that it is not |  | U | The card issuer is not certified |  | [optional] 
-**currency** | **String** | The currency the transaction was processed in. This is an `ISO4217` alpha currency value. | [optional] 
-**datetime** | **DateTime** | The UTC date time of the transaction in ISO data time format.  | [optional] 
-**eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.  | [optional] 
-**identifier** | **String** | The identifier provided within the request. | [optional] 
-**live** | **Boolean** | Used to identify that a tranasction was processed on a live authorisation platform. | [optional] 
-**maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] 
-**merchantid** | **Integer** | The merchant id that processed this transaction. | [optional] 
-**result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value   | Code | Abbrev | Description |  |------|-------|-------------|  | 0 | Declined | Declined |  | 1 | Accepted | Accepted |  | 2 | Rejected | Rejected |  | 3 | Not Attempted | Not Attempted |  | 4 | Referred | Referred |  | 5 | PinRetry | Perform PIN Retry |  | 6 | ForSigVer | Force Signature Verification |  | 7 | Hold | Hold |  | 8 | SecErr | Security Error |  | 9 | CallAcq | Call Acquirer |  | 10 | DNH | Do Not Honour |  | 11 | RtnCrd | Retain Card |  | 12 | ExprdCrd | Expired Card |  | 13 | InvldCrd | Invalid Card No |  | 14 | PinExcd | Pin Tries Exceeded |  | 15 | PinInvld | Pin Invalid |  | 16 | AuthReq | Authentication Required |  | 17 | AuthenFail | Authentication Failed |  | 18 | Verified | Card Verified |  | 19 | Cancelled | Cancelled |  | 20 | Un | Unknown |  | [optional] 
-**result_code** | **String** | The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure. Codes may start with an alpha character i.e. C001 indicating a type of error such as a card validation error.  | [optional] 
-**result_message** | **String** | The message regarding the result which provides further narrative to the result code.  | [optional] 
-**scheme** | **String** | A name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] 
-**sha256** | **String** | A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating  * authcode  * amount  * response_code  * merchant_id  * trans_no  * identifier  * licence_key - which is not provided in the response.  | [optional] 
-**trans_status** | **String** | Used to identify the status of a transaction. The status is used to track a transaction through its life cycle.  | Id | Description | |----|-------------| | O | Transaction is open for settlement | | A | Transaction is assigned for settlement and can no longer be voided | | S | Transaction has been settled   | | D | Transaction has been declined | | R | Transaction has been rejected | | P | Transaction has been authorised only and awaiting a capture. Used in pre-auth situations | | C | Transaction has been cancelled | | E | Transaction has expired | | I | Transaction has been initialised but no action was able to be carried out | | H | Transaction is awaiting authorisation | | . | Transaction is on hold | | V | Transaction has been verified |  | [optional] 
-**transno** | **Integer** | The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | The amount of the transaction processed. | [optional] |
+| **atrn** | **String** | A reference number provided by the acquirer for a transaction it can be used to cross reference transactions with an Acquirers reporting panel.  | [optional] |
+| **atsd** | **String** | Additional Transaction Security Data used for ecommerce transactions to decipher security capabilities and attempts against a transaction. | [optional] |
+| **authcode** | **String** | The authorisation code as returned by the card issuer or acquiring bank when a transaction has successfully   been authorised. Authorisation codes contain alphanumeric values. Whilst the code confirms authorisation it   should not be used to determine whether a transaction was successfully processed. For instance an auth code   may be returned when a transaction has been subsequently declined due to a CSC mismatch.  | [optional] |
+| **authen_result** | **String** | The result of any authentication using 3d_secure authorisation against ecommerce transactions. Values are:  <table> <tr> <th>Value</th> <th>Description</th> </tr> <tr> <td>Y</td> <td>Authentication Successful. The Cardholder's password was successfully validated.</td> </tr> <tr> <td>N</td> <td>Authentication Failed. Customer failed or cancelled authentication, transaction denied.</td> </tr> <tr> <td>A</td> <td>Attempts Processing Performed Authentication could not be completed but a proof of authentication attempt (CAVV) was generated.</td> </tr> <tr> <td>U</td> <td>Authentication Could Not Be Performed Authentication could not be completed, due to technical or other problem.</td> </tr> </table>  | [optional] |
+| **authorised** | **Boolean** | A boolean definition that indicates that the transaction was authorised. It will return false if the transaction  was declined, rejected or cancelled due to CSC matching failures.  Attention should be referenced to the AuthResult and Response code for accurate determination of the result.  | [optional] |
+| **avs_result** | **String** | The AVS result codes determine the result of checking the AVS values within the Address Verification fraud system. If a transaction is declined due to the AVS code not matching, this value can help determine the reason for the decline.  <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td>Y</td><td>Address and 5 digit post code match</td></tr> <tr><td>M</td><td>Street address and Postal codes match for international transaction</td></tr> <tr><td>U</td><td>No AVS data available from issuer auth system</td></tr> <tr><td>A</td><td>Addres matches, post code does not</td></tr> <tr><td>I</td><td>Address information verified for international transaction</td></tr> <tr><td>Z</td><td>5 digit post code matches, Address does not</td></tr> <tr><td>W</td><td>9 digit post code matches, Address does not</td></tr> <tr><td>X</td><td>Postcode and address match</td></tr> <tr><td>B</td><td>Postal code not verified due to incompatible formats</td></tr> <tr><td>P</td><td>Postal codes match. Street address not verified due to to incompatible formats</td></tr> <tr><td>E</td><td>AVS Error</td></tr> <tr><td>C</td><td>Street address and Postal code not verified due to incompatible formats</td></tr> <tr><td>D</td><td>Street address and postal codes match</td></tr> <tr><td> </td><td>No information</td></tr> <tr><td>N</td><td>Neither postcode nor address match</td></tr> <tr><td>R</td><td>Retry, System unavailble or Timed Out</td></tr> <tr><td>S</td><td>AVS Service not supported by issuer or processor</td></tr> <tr><td>G</td><td>Issuer does not participate in AVS</td></tr> </table>  | [optional] |
+| **bin_commercial** | **Boolean** | Determines whether the bin range was found to be a commercial or business card. | [optional] |
+| **bin_debit** | **Boolean** | Determines whether the bin range was found to be a debit card. If false the card was considered as a credit card. | [optional] |
+| **bin_description** | **String** | A description of the bin range found for the card. | [optional] |
+| **cavv** | **String** | The cardholder authentication verification value which can be returned for verification purposes of the authenticated  transaction for dispute realisation.  | [optional] |
+| **context** | **String** | The context which processed the transaction, can be used for support purposes to trace transactions. | [optional] |
+| **csc_result** | **String** | The CSC rseult codes determine the result of checking the provided CSC value within the Card Security Code fraud system. If a transaction is declined due to the CSC code not matching, this value can help determine the reason for the decline.  <table> <tr> <th>Code</th> <th>Description</th> </tr> <tr><td> </td><td>No information</td></tr> <tr><td>M</td><td>Card verification data matches</td></tr> <tr><td>N</td><td>Card verification data was checked but did not match</td></tr> <tr><td>P</td><td>Card verification was not processed</td></tr> <tr><td>S</td><td>The card verification data should be on the card but the merchant indicates that it is not</td></tr> <tr><td>U</td><td>The card issuer is not certified</td></tr> </table>  | [optional] |
+| **currency** | **String** | The currency the transaction was processed in. This is an `ISO4217` alpha currency value. | [optional] |
+| **datetime** | **Time** | The UTC date time of the transaction in ISO data time format.  | [optional] |
+| **eci** | **String** | An Electronic Commerce Indicator (ECI) used to identify the result of authentication using 3DSecure.  | [optional] |
+| **identifier** | **String** | The identifier provided within the request. | [optional] |
+| **live** | **Boolean** | Used to identify that a transaction was processed on a live authorisation platform. | [optional] |
+| **maskedpan** | **String** | A masked value of the card number used for processing displaying limited values that can be used on a receipt.  | [optional] |
+| **merchantid** | **Integer** | The merchant id that processed this transaction. |  |
+| **result** | **Integer** | An integer result that indicates the outcome of the transaction. The Code value below maps to the result value  <table> <tr> <th>Code</th> <th>Abbrev</th> <th>Description</th> </tr> <tr><td>0</td><td>Declined</td><td>Declined</td></tr> <tr><td>1</td><td>Accepted</td><td>Accepted</td></tr> <tr><td>2</td><td>Rejected</td><td>Rejected</td></tr> <tr><td>3</td><td>Not Attempted</td><td>Not Attempted</td></tr> <tr><td>4</td><td>Referred</td><td>Referred</td></tr> <tr><td>5</td><td>PinRetry</td><td>Perform PIN Retry</td></tr> <tr><td>6</td><td>ForSigVer</td><td>Force Signature Verification</td></tr> <tr><td>7</td><td>Hold</td><td>Hold</td></tr> <tr><td>8</td><td>SecErr</td><td>Security Error</td></tr> <tr><td>9</td><td>CallAcq</td><td>Call Acquirer</td></tr> <tr><td>10</td><td>DNH</td><td>Do Not Honour</td></tr> <tr><td>11</td><td>RtnCrd</td><td>Retain Card</td></tr> <tr><td>12</td><td>ExprdCrd</td><td>Expired Card</td></tr> <tr><td>13</td><td>InvldCrd</td><td>Invalid Card No</td></tr> <tr><td>14</td><td>PinExcd</td><td>Pin Tries Exceeded</td></tr> <tr><td>15</td><td>PinInvld</td><td>Pin Invalid</td></tr> <tr><td>16</td><td>AuthReq</td><td>Authentication Required</td></tr> <tr><td>17</td><td>AuthenFail</td><td>Authentication Failed</td></tr> <tr><td>18</td><td>Verified</td><td>Card Verified</td></tr> <tr><td>19</td><td>Cancelled</td><td>Cancelled</td></tr> <tr><td>20</td><td>Un</td><td>Unknown</td></tr> <tr><td>21</td><td>Challenged</td><td>Challenged</td></tr> <tr><td>22</td><td>Decoupled</td><td>Decoupled</td></tr> <tr><td>23</td><td>Denied</td><td>Permission Denied</td></tr> </table>  |  |
+| **result_code** | **String** | The result code as defined in the Response Codes Reference for example 000 is an accepted live transaction whilst 001 is an accepted test transaction. Result codes identify the source of success and failure.  Codes may start with an alpha character i.e. C001 indicating a type of error such as a card validation error.  |  |
+| **result_message** | **String** | The message regarding the result which provides further narrative to the result code.  |  |
+| **scheme** | **String** | The name of the card scheme of the transaction that processed the transaction such as Visa or MasterCard.  | [optional] |
+| **scheme_id** | **String** | The name of the card scheme of the transaction such as VI or MC.  | [optional] |
+| **scheme_logo** | **String** | A url containing a logo of the card scheme.  | [optional] |
+| **sha256** | **String** | A SHA256 digest value of the transaction used to validate the response data The digest is calculated by concatenating   * authcode   * amount   * response_code   * merchant_id   * trans_no   * identifier   * licence_key - which is not provided in the response.  | [optional] |
+| **trans_status** | **String** | Used to identify the status of a transaction. The status is used to track a transaction through its life cycle.  <table> <tr> <th>Id</th> <th>Description</th> </tr> <tr> <td>O</td> <td>Transaction is open for settlement</td> </tr> <tr> <td>A</td> <td>Transaction is assigned for settlement and can no longer be voided</td> </tr> <tr> <td>S</td> <td>Transaction has been settled</td> </tr> <tr> <td>D</td> <td>Transaction has been declined</td> </tr> <tr> <td>R</td> <td>Transaction has been rejected</td> </tr> <tr> <td>P</td> <td>Transaction has been authorised only and awaiting a capture. Used in pre-auth situations</td> </tr> <tr> <td>C</td> <td>Transaction has been cancelled</td> </tr> <tr> <td>E</td> <td>Transaction has expired</td> </tr> <tr> <td>I</td> <td>Transaction has been initialised but no action was able to be carried out</td> </tr> <tr> <td>H</td> <td>Transaction is awaiting authorisation</td> </tr> <tr> <td>.</td> <td>Transaction is on hold</td> </tr> <tr> <td>V</td> <td>Transaction has been verified</td> </tr> </table>  | [optional] |
+| **transno** | **Integer** | The resulting transaction number, ordered incrementally from 1 for every merchant_id. The value will default to less than 1 for transactions that do not have a transaction number issued.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AuthResponse.new(amount: 3600,
-                                 atrn: null,
-                                 atsd: null,
-                                 authcode: 001245A,
-                                 authen_result: null,
-                                 authorised: true,
-                                 avs_result: null,
-                                 bin_commercial: null,
-                                 bin_debit: null,
-                                 bin_description: null,
-                                 cavv: null,
-                                 context: aspiu352908ns47n343598bads,
-                                 csc_result: null,
-                                 currency: GBP,
-                                 datetime: 2020-01-02T18:32:28Z,
-                                 eci: null,
-                                 identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
-                                 live: true,
-                                 maskedpan: 4***********0002,
-                                 merchantid: 11223344,
-                                 result: 1,
-                                 result_code: 0,
-                                 result_message: Accepted Transaction,
-                                 scheme: Visa,
-                                 sha256: null,
-                                 trans_status: null,
-                                 transno: 78416)
+instance = CityPayApiClient::AuthResponse.new(
+  amount: 3600,
+  atrn: null,
+  atsd: null,
+  authcode: 001245A,
+  authen_result: null,
+  authorised: true,
+  avs_result: null,
+  bin_commercial: null,
+  bin_debit: null,
+  bin_description: Platinum Card,
+  cavv: null,
+  context: aspiu352908ns47n343598bads,
+  csc_result: null,
+  currency: GBP,
+  datetime: 2020-01-02T18:32:28Z,
+  eci: null,
+  identifier: 95b857a1-5955-4b86-963c-5a6dbfc4fb95,
+  live: true,
+  maskedpan: 4***********0002,
+  merchantid: 11223344,
+  result: 1,
+  result_code: 0,
+  result_message: Accepted Transaction,
+  scheme: Visa,
+  scheme_id: MC,
+  scheme_logo: https://cdn.citypay.com/img/cs/visa-logo.svg,
+  sha256: null,
+  trans_status: null,
+  transno: 78416
+)
 ```
 
-

data/docs/AuthenRequired.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**acs_url** | **String** | The url of the Access Control Server (ACS) to forward the user to.  | [optional] 
-**md** | **String** | Merchant Data (MD) which should be sent to the ACS to establish and reference the authentication session.  | [optional] 
-**pareq** | **String** | The Payer Authentication Request packet which should be `POSTed` to the Url of the ACS to establish the authentication session. Data should be sent untouched.  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acs_url** | **String** | The url of the Access Control Server (ACS) to forward the user to.  | [optional] |
+| **md** | **String** | Merchant Data (MD) which should be sent to the ACS to establish and reference the authentication session.  | [optional] |
+| **pareq** | **String** | The Payer Authentication Request packet which should be `POSTed` to the Url of the ACS to establish the authentication session. Data should be sent untouched.  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'CityPayApiClient'
+require 'citypay_api_client'
 
-instance = CityPayApiClient::AuthenRequired.new(acs_url: https://acs.cardissuer.com/3dsv1,
-                                 md: null,
-                                 pareq: eNrNWdnOo0qSfpXSmUuf0+w2tFy/lOyYxYDZ79h3sAEbm6cfbFfV+bu6pqe7R2qNJeQkiIwlMyK+...)
+instance = CityPayApiClient::AuthenRequired.new(
+  acs_url: https://acs.cardissuer.com/3dsv1,
+  md: null,
+  pareq: eNrNWdnOo0qSfpXSmUuf0+w2tFy/lOyYxYDZ79h3sAEbm6cfbFfV+bu6pqe7R2qNJeQkiIwlMyK+...
+)
 ```
 
-