cybersource-rest-client 0.0.43 → 0.0.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md +2 -2
  2. package/docs/PaymentsApi.md +50 -0
  3. package/docs/PtsV2PaymentsPost201Response1.md +15 -0
  4. package/docs/PtsV2PaymentsPost201Response1OrderInformation.md +9 -0
  5. package/docs/PtsV2PaymentsPost201Response1OrderInformationBillTo.md +18 -0
  6. package/docs/PtsV2PaymentsPost201Response1OrderInformationShipTo.md +16 -0
  7. package/docs/PtsV2PaymentsPost201Response1PaymentInformation.md +10 -0
  8. package/docs/PtsV2PaymentsPost201Response1PaymentInformationBank.md +8 -0
  9. package/docs/PtsV2PaymentsPost201Response1PaymentInformationBankAccount.md +8 -0
  10. package/docs/PtsV2PaymentsPost201Response1PaymentInformationPaymentType.md +8 -0
  11. package/docs/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod.md +8 -0
  12. package/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md +13 -0
  13. package/docs/PtsV2PaymentsPost201Response1ProcessorInformationAvs.md +8 -0
  14. package/docs/PtsV2PaymentsPost201Response1ProcessorInformationSellerProtection.md +8 -0
  15. package/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md +2 -0
  16. package/docs/PtsV2PaymentsPost201ResponseRiskInformation.md +1 -1
  17. package/docs/PtsV2PaymentsRefundPost201Response.md +1 -1
  18. package/docs/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation.md +11 -0
  19. package/docs/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md +1 -0
  20. package/docs/Ptsv1pushfundstransferAggregatorInformation.md +10 -0
  21. package/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md +16 -0
  22. package/docs/Ptsv1pushfundstransferClientReferenceInformation.md +11 -0
  23. package/docs/Ptsv1pushfundstransferMerchantDefinedInformation.md +9 -0
  24. package/docs/Ptsv1pushfundstransferMerchantInformation.md +11 -0
  25. package/docs/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md +13 -0
  26. package/docs/Ptsv1pushfundstransferOrderInformation.md +10 -0
  27. package/docs/Ptsv1pushfundstransferOrderInformationAmountDetails.md +9 -0
  28. package/docs/Ptsv1pushfundstransferOrderInformationSurcharge.md +8 -0
  29. package/docs/Ptsv1pushfundstransferPointOfServiceInformation.md +12 -0
  30. package/docs/Ptsv1pushfundstransferProcessingInformation.md +15 -0
  31. package/docs/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md +9 -0
  32. package/docs/Ptsv1pushfundstransferProcessingInformationRecurringOptions.md +8 -0
  33. package/docs/Ptsv1pushfundstransferProcessingOptions.md +8 -0
  34. package/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptions.md +8 -0
  35. package/docs/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md +8 -0
  36. package/docs/Ptsv1pushfundstransferRecipientInformation.md +21 -0
  37. package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformation.md +8 -0
  38. package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md +15 -0
  39. package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer.md +8 -0
  40. package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier.md +8 -0
  41. package/docs/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument.md +8 -0
  42. package/docs/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md +9 -0
  43. package/docs/Ptsv1pushfundstransferSenderInformation.md +24 -0
  44. package/docs/Ptsv1pushfundstransferSenderInformationAccount.md +9 -0
  45. package/docs/Ptsv1pushfundstransferSenderInformationPaymentInformation.md +8 -0
  46. package/docs/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.md +13 -0
  47. package/docs/Ptsv1pushfundstransferSenderInformationPersonalIdentification.md +10 -0
  48. package/docs/Ptsv2paymentsDeviceInformation.md +1 -0
  49. package/docs/Ptsv2paymentsMerchantInformation.md +1 -0
  50. package/docs/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md +2 -2
  51. package/docs/Ptsv2paymentsOrderInformationBillTo.md +2 -0
  52. package/docs/Ptsv2paymentsPaymentInformation.md +2 -0
  53. package/docs/Ptsv2paymentsPaymentInformationBank.md +1 -0
  54. package/docs/Ptsv2paymentsPaymentInformationPaymentType.md +1 -2
  55. package/docs/Ptsv2paymentsPaymentInformationPaymentTypeMethod.md +2 -1
  56. package/docs/Ptsv2paymentsProcessingInformation.md +2 -1
  57. package/docs/Ptsv2paymentsidcapturesBuyerInformation.md +4 -0
  58. package/docs/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.md +8 -0
  59. package/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md +4 -0
  60. package/docs/Ptsv2paymentsidrefundsClientReferenceInformation.md +17 -0
  61. package/docs/Ptsv2paymentsidrefundsPaymentInformation.md +2 -2
  62. package/docs/Ptsv2paymentsidrefundsPaymentInformationBank.md +1 -0
  63. package/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md +2 -0
  64. package/docs/Ptsv2paymentsidrefundsPaymentInformationEWallet.md +8 -0
  65. package/docs/Ptsv2paymentsidrefundsPaymentInformationPaymentType.md +10 -0
  66. package/docs/Ptsv2paymentsidrefundsPaymentInformationPaymentTypeMethod.md +8 -0
  67. package/docs/Ptsv2paymentsidrefundsProcessingInformation.md +3 -0
  68. package/docs/Ptsv2paymentsidrefundsProcessingInformationRefundOptions.md +8 -0
  69. package/docs/Ptsv2paymentsidvoidsPaymentInformation.md +1 -1
  70. package/docs/Ptsv2refreshpaymentstatusidAgreementInformation.md +8 -0
  71. package/docs/Ptsv2refreshpaymentstatusidClientReferenceInformation.md +9 -0
  72. package/docs/Ptsv2refreshpaymentstatusidPaymentInformation.md +9 -0
  73. package/docs/{TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCustomer.md → Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md} +1 -1
  74. package/docs/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType.md +9 -0
  75. package/docs/Ptsv2refreshpaymentstatusidProcessingInformation.md +8 -0
  76. package/docs/PushFunds201Response.md +18 -0
  77. package/docs/PushFunds201ResponseClientReferenceInformation.md +9 -0
  78. package/docs/PushFunds201ResponseErrorInformation.md +10 -0
  79. package/docs/PushFunds201ResponseErrorInformationDetails.md +9 -0
  80. package/docs/PushFunds201ResponseLinks.md +11 -0
  81. package/docs/PushFunds201ResponseLinksCustomer.md +9 -0
  82. package/docs/PushFunds201ResponseLinksInstrumentIdentifier.md +9 -0
  83. package/docs/PushFunds201ResponseLinksPaymentInstrument.md +9 -0
  84. package/docs/PushFunds201ResponseLinksSelf.md +9 -0
  85. package/docs/PushFunds201ResponseMerchantInformation.md +8 -0
  86. package/docs/PushFunds201ResponseMerchantInformationMerchantDescriptor.md +10 -0
  87. package/docs/PushFunds201ResponseOrderInformation.md +8 -0
  88. package/docs/PushFunds201ResponseOrderInformationAmountDetails.md +11 -0
  89. package/docs/PushFunds201ResponseProcessorInformation.md +13 -0
  90. package/docs/PushFunds201ResponseRecipientInformation.md +8 -0
  91. package/docs/PushFunds201ResponseRecipientInformationCard.md +9 -0
  92. package/docs/PushFunds400Response.md +13 -0
  93. package/docs/PushFunds400ResponseDetails.md +9 -0
  94. package/docs/PushFunds401Response.md +11 -0
  95. package/docs/PushFunds404Response.md +11 -0
  96. package/docs/PushFunds502Response.md +12 -0
  97. package/docs/PushFundsApi.md +73 -0
  98. package/docs/PushFundsRequest.md +17 -0
  99. package/docs/RefreshPaymentStatusRequest.md +11 -0
  100. package/docs/RefundCaptureRequest.md +1 -1
  101. package/docs/RefundPaymentRequest.md +1 -1
  102. package/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md +1 -1
  103. package/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md +1 -1
  104. package/docs/UnifiedCheckoutCaptureContextApi.md +1 -1
  105. package/package.json +1 -1
  106. package/src/api/PaymentsApi.js +56 -4
  107. package/src/api/PushFundsApi.js +141 -0
  108. package/src/api/UnifiedCheckoutCaptureContextApi.js +1 -1
  109. package/src/authentication/http/SignatureParameterGenerator.js +2 -2
  110. package/src/index.js +388 -18
  111. package/src/model/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.js +2 -2
  112. package/src/model/PtsV2PaymentsPost201Response1.js +141 -0
  113. package/src/model/PtsV2PaymentsPost201Response1OrderInformation.js +89 -0
  114. package/src/model/PtsV2PaymentsPost201Response1OrderInformationBillTo.js +172 -0
  115. package/src/model/PtsV2PaymentsPost201Response1OrderInformationShipTo.js +154 -0
  116. package/src/model/PtsV2PaymentsPost201Response1PaymentInformation.js +97 -0
  117. package/src/model/PtsV2PaymentsPost201Response1PaymentInformationBank.js +81 -0
  118. package/src/model/PtsV2PaymentsPost201Response1PaymentInformationBankAccount.js +82 -0
  119. package/src/model/PtsV2PaymentsPost201Response1PaymentInformationPaymentType.js +81 -0
  120. package/src/model/PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod.js +82 -0
  121. package/src/model/PtsV2PaymentsPost201Response1ProcessorInformation.js +125 -0
  122. package/src/model/PtsV2PaymentsPost201Response1ProcessorInformationAvs.js +82 -0
  123. package/src/model/PtsV2PaymentsPost201Response1ProcessorInformationSellerProtection.js +82 -0
  124. package/src/model/PtsV2PaymentsPost201ResponseProcessorInformation.js +16 -0
  125. package/src/model/PtsV2PaymentsPost201ResponseRiskInformation.js +7 -6
  126. package/src/model/PtsV2PaymentsRefundPost201Response.js +6 -6
  127. package/src/model/PtsV2PaymentsRefundPost201ResponseClientReferenceInformation.js +109 -0
  128. package/src/model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.js +9 -0
  129. package/src/model/Ptsv1pushfundstransferAggregatorInformation.js +99 -0
  130. package/src/model/Ptsv1pushfundstransferAggregatorInformationSubMerchant.js +154 -0
  131. package/src/model/Ptsv1pushfundstransferClientReferenceInformation.js +109 -0
  132. package/src/model/Ptsv1pushfundstransferMerchantDefinedInformation.js +91 -0
  133. package/src/model/Ptsv1pushfundstransferMerchantInformation.js +108 -0
  134. package/src/model/Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.js +127 -0
  135. package/src/model/Ptsv1pushfundstransferOrderInformation.js +99 -0
  136. package/src/model/Ptsv1pushfundstransferOrderInformationAmountDetails.js +93 -0
  137. package/src/model/Ptsv1pushfundstransferOrderInformationSurcharge.js +82 -0
  138. package/src/model/Ptsv1pushfundstransferPointOfServiceInformation.js +118 -0
  139. package/src/model/Ptsv1pushfundstransferProcessingInformation.js +144 -0
  140. package/src/model/Ptsv1pushfundstransferProcessingInformationPayoutsOptions.js +91 -0
  141. package/src/model/Ptsv1pushfundstransferProcessingInformationRecurringOptions.js +82 -0
  142. package/src/model/Ptsv1pushfundstransferProcessingOptions.js +81 -0
  143. package/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptions.js +81 -0
  144. package/src/model/Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.js +82 -0
  145. package/src/model/Ptsv1pushfundstransferRecipientInformation.js +197 -0
  146. package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformation.js +81 -0
  147. package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.js +142 -0
  148. package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardCustomer.js +82 -0
  149. package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardInstrumentIdentifier.js +82 -0
  150. package/src/model/Ptsv1pushfundstransferRecipientInformationPaymentInformationCardPaymentInstrument.js +82 -0
  151. package/src/model/Ptsv1pushfundstransferRecipientInformationPersonalIdentification.js +91 -0
  152. package/src/model/Ptsv1pushfundstransferSenderInformation.js +223 -0
  153. package/src/model/Ptsv1pushfundstransferSenderInformationAccount.js +91 -0
  154. package/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformation.js +81 -0
  155. package/src/model/Ptsv1pushfundstransferSenderInformationPaymentInformationCard.js +127 -0
  156. package/src/model/Ptsv1pushfundstransferSenderInformationPersonalIdentification.js +100 -0
  157. package/src/model/Ptsv2paymentsDeviceInformation.js +9 -0
  158. package/src/model/Ptsv2paymentsMerchantInformation.js +9 -0
  159. package/src/model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.js +2 -2
  160. package/src/model/Ptsv2paymentsOrderInformationBillTo.js +18 -0
  161. package/src/model/Ptsv2paymentsPaymentInformation.js +18 -0
  162. package/src/model/Ptsv2paymentsPaymentInformationBank.js +9 -0
  163. package/src/model/Ptsv2paymentsPaymentInformationPaymentType.js +1 -10
  164. package/src/model/Ptsv2paymentsPaymentInformationPaymentTypeMethod.js +10 -1
  165. package/src/model/Ptsv2paymentsProcessingInformation.js +10 -1
  166. package/src/model/Ptsv2paymentsidcapturesBuyerInformation.js +39 -4
  167. package/src/model/Ptsv2paymentsidcapturesBuyerInformationPersonalIdentification.js +82 -0
  168. package/src/model/Ptsv2paymentsidcapturesOrderInformationBillTo.js +36 -0
  169. package/src/model/Ptsv2paymentsidrefundsClientReferenceInformation.js +162 -0
  170. package/src/model/Ptsv2paymentsidrefundsPaymentInformation.js +8 -8
  171. package/src/model/Ptsv2paymentsidrefundsPaymentInformationBank.js +9 -0
  172. package/src/model/Ptsv2paymentsidrefundsPaymentInformationCard.js +18 -0
  173. package/src/model/Ptsv2paymentsidrefundsPaymentInformationEWallet.js +82 -0
  174. package/src/model/Ptsv2paymentsidrefundsPaymentInformationPaymentType.js +99 -0
  175. package/src/model/Ptsv2paymentsidrefundsPaymentInformationPaymentTypeMethod.js +82 -0
  176. package/src/model/Ptsv2paymentsidrefundsProcessingInformation.js +30 -4
  177. package/src/model/Ptsv2paymentsidrefundsProcessingInformationRefundOptions.js +82 -0
  178. package/src/model/Ptsv2paymentsidvoidsPaymentInformation.js +6 -6
  179. package/src/model/Ptsv2refreshpaymentstatusidAgreementInformation.js +82 -0
  180. package/src/model/Ptsv2refreshpaymentstatusidClientReferenceInformation.js +91 -0
  181. package/src/model/Ptsv2refreshpaymentstatusidPaymentInformation.js +89 -0
  182. package/src/model/{TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCustomer.js → Ptsv2refreshpaymentstatusidPaymentInformationCustomer.js} +8 -8
  183. package/src/model/Ptsv2refreshpaymentstatusidPaymentInformationPaymentType.js +90 -0
  184. package/src/model/Ptsv2refreshpaymentstatusidProcessingInformation.js +82 -0
  185. package/src/model/PushFunds201Response.js +165 -0
  186. package/src/model/PushFunds201ResponseClientReferenceInformation.js +91 -0
  187. package/src/model/PushFunds201ResponseErrorInformation.js +99 -0
  188. package/src/model/PushFunds201ResponseErrorInformationDetails.js +91 -0
  189. package/src/model/PushFunds201ResponseLinks.js +105 -0
  190. package/src/model/PushFunds201ResponseLinksCustomer.js +92 -0
  191. package/src/model/PushFunds201ResponseLinksInstrumentIdentifier.js +92 -0
  192. package/src/model/PushFunds201ResponseLinksPaymentInstrument.js +92 -0
  193. package/src/model/PushFunds201ResponseLinksSelf.js +92 -0
  194. package/src/model/PushFunds201ResponseMerchantInformation.js +81 -0
  195. package/src/model/PushFunds201ResponseMerchantInformationMerchantDescriptor.js +100 -0
  196. package/src/model/PushFunds201ResponseOrderInformation.js +81 -0
  197. package/src/model/PushFunds201ResponseOrderInformationAmountDetails.js +110 -0
  198. package/src/model/PushFunds201ResponseProcessorInformation.js +127 -0
  199. package/src/model/PushFunds201ResponseRecipientInformation.js +81 -0
  200. package/src/model/PushFunds201ResponseRecipientInformationCard.js +91 -0
  201. package/src/model/PushFunds400Response.js +126 -0
  202. package/src/model/PushFunds400ResponseDetails.js +91 -0
  203. package/src/model/PushFunds401Response.js +109 -0
  204. package/src/model/PushFunds404Response.js +109 -0
  205. package/src/model/PushFunds502Response.js +118 -0
  206. package/src/model/PushFundsRequest.js +156 -0
  207. package/src/model/RefreshPaymentStatusRequest.js +105 -0
  208. package/src/model/RefundCaptureRequest.js +6 -6
  209. package/src/model/RefundPaymentRequest.js +6 -6
  210. package/src/model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.js +1 -1
  211. package/src/model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.js +6 -6
  212. package/docs/PtsV2PaymentsPost201ResponseRiskInformationProviders.md +0 -8
  213. package/docs/PtsV2PaymentsPost201ResponseRiskInformationProvidersProviderName.md +0 -9
  214. package/src/model/PtsV2PaymentsPost201ResponseRiskInformationProviders.js +0 -81
  215. package/src/model/PtsV2PaymentsPost201ResponseRiskInformationProvidersProviderName.js +0 -90
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
7
- **amount** | **String** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | [optional]
6
+ **type** | **String** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
7
+ **amount** | **String** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | | [optional]
8
8
  **rate** | **String** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional]
9
9
 
10
10
 
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**createPayment**](PaymentsApi.md#createPayment) | **POST** /pts/v2/payments | Process a Payment
8
8
  [**incrementAuth**](PaymentsApi.md#incrementAuth) | **PATCH** /pts/v2/payments/{id} | Increment an Authorization
9
+ [**refreshPaymentStatus**](PaymentsApi.md#refreshPaymentStatus) | **POST** /pts/v2/refresh-payment-status/{id} | Check a Payment Status
9
10
 
10
11
 
11
12
  <a name="createPayment"></a>
@@ -103,3 +104,52 @@ No authorization required
103
104
  - **Content-Type**: application/json;charset=utf-8
104
105
  - **Accept**: application/hal+json;charset=utf-8
105
106
 
107
+ <a name="refreshPaymentStatus"></a>
108
+ # **refreshPaymentStatus**
109
+ > PtsV2PaymentsPost201Response1 refreshPaymentStatus(id, refreshPaymentStatusRequest)
110
+
111
+ Check a Payment Status
112
+
113
+ Checks and updates the payment status
114
+
115
+ ### Example
116
+ ```javascript
117
+ var CyberSource = require('CyberSource');
118
+
119
+ var apiInstance = new CyberSource.PaymentsApi();
120
+
121
+ var id = "id_example"; // String | The payment id whose status needs to be checked and updated.
122
+
123
+ var refreshPaymentStatusRequest = new CyberSource.RefreshPaymentStatusRequest(); // RefreshPaymentStatusRequest |
124
+
125
+
126
+ var callback = function(error, data, response) {
127
+ if (error) {
128
+ console.error(error);
129
+ } else {
130
+ console.log('API called successfully. Returned data: ' + data);
131
+ }
132
+ };
133
+ apiInstance.refreshPaymentStatus(id, refreshPaymentStatusRequest, callback);
134
+ ```
135
+
136
+ ### Parameters
137
+
138
+ Name | Type | Description | Notes
139
+ ------------- | ------------- | ------------- | -------------
140
+ **id** | **String**| The payment id whose status needs to be checked and updated. |
141
+ **refreshPaymentStatusRequest** | [**RefreshPaymentStatusRequest**](RefreshPaymentStatusRequest.md)| |
142
+
143
+ ### Return type
144
+
145
+ [**PtsV2PaymentsPost201Response1**](PtsV2PaymentsPost201Response1.md)
146
+
147
+ ### Authorization
148
+
149
+ No authorization required
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: application/json;charset=utf-8
154
+ - **Accept**: application/hal+json;charset=utf-8
155
+
@@ -0,0 +1,15 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [optional]
7
+ **status** | **String** | The status of the submitted transaction. Possible values: - AUTHORIZED - PARTIAL_AUTHORIZED - AUTHORIZED_PENDING_REVIEW - AUTHORIZED_RISK_DECLINED - PENDING_AUTHENTICATION - PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional]
8
+ **submitTimeUtc** | **String** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
9
+ **processorInformation** | [**PtsV2PaymentsPost201Response1ProcessorInformation**](PtsV2PaymentsPost201Response1ProcessorInformation.md) | | [optional]
10
+ **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional]
11
+ **paymentInformation** | [**PtsV2PaymentsPost201Response1PaymentInformation**](PtsV2PaymentsPost201Response1PaymentInformation.md) | | [optional]
12
+ **orderInformation** | [**PtsV2PaymentsPost201Response1OrderInformation**](PtsV2PaymentsPost201Response1OrderInformation.md) | | [optional]
13
+ **clientReferenceInformation** | [**PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation**](PtsV2IncrementalAuthorizationPatch201ResponseClientReferenceInformation.md) | | [optional]
14
+
15
+
@@ -0,0 +1,9 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1OrderInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **billTo** | [**PtsV2PaymentsPost201Response1OrderInformationBillTo**](PtsV2PaymentsPost201Response1OrderInformationBillTo.md) | | [optional]
7
+ **shipTo** | [**PtsV2PaymentsPost201Response1OrderInformationShipTo**](PtsV2PaymentsPost201Response1OrderInformationShipTo.md) | | [optional]
8
+
9
+
@@ -0,0 +1,18 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1OrderInformationBillTo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates &#x60;orderInformation.billTo.firstName&#x60; and &#x60;orderInformation.billTo.lastName&#x60;. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
7
+ **lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates &#x60;orderInformation.billTo.firstName&#x60; and &#x60;orderInformation.billTo.lastName&#x60;. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
8
+ **nameSuffix** | **String** | Customer’s name suffix. | [optional]
9
+ **address1** | **String** | Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional]
10
+ **address2** | **String** | Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate &#x60;orderInformation.billTo.address1&#x60; and &#x60;orderInformation.billTo.address2&#x60;, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville &#x60;orderInformation.billTo.address1&#x60; and &#x60;orderInformation.billTo.address2&#x60; together cannot exceed 20 characters. String (20) #### All Other Processors String (60) | [optional]
11
+ **locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
12
+ **administrativeArea** | **String** | State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
13
+ **postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** &#x60;12345-6789&#x60; When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** &#x60;A1B 2C3&#x60; **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60; and the address is in the U.S. or Canada. Optional if &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60; and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### All other processors: Optional field. | [optional]
14
+ **country** | **String** | Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
15
+ **email** | **String** | Customer&#39;s email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the &#x60;customer_email&#x60; request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won&#39;t work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when &#x60;processingInformation.billPaymentOptions.billPayment&#x3D;true&#x60; and &#x60;pointOfSaleInformation.entryMode&#x3D;keyed&#x60;. #### Worldpay VAP Optional field. #### All other processors Not used. | [optional]
16
+ **verificationStatus** | **String** | Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED | [optional]
17
+
18
+
@@ -0,0 +1,16 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1OrderInformationShipTo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **firstName** | **String** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional]
7
+ **lastName** | **String** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional]
8
+ **address1** | **String** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
9
+ **address2** | **String** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
10
+ **locality** | **String** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
11
+ **administrativeArea** | **String** | State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
12
+ **postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
13
+ **country** | **String** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. | [optional]
14
+ **phoneNumber** | **String** | Phone number associated with the shipping address. | [optional]
15
+
16
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1PaymentInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **paymentType** | [**PtsV2PaymentsPost201Response1PaymentInformationPaymentType**](PtsV2PaymentsPost201Response1PaymentInformationPaymentType.md) | | [optional]
7
+ **customer** | [**Ptsv2refreshpaymentstatusidPaymentInformationCustomer**](Ptsv2refreshpaymentstatusidPaymentInformationCustomer.md) | | [optional]
8
+ **bank** | [**PtsV2PaymentsPost201Response1PaymentInformationBank**](PtsV2PaymentsPost201Response1PaymentInformationBank.md) | | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1PaymentInformationBank
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **account** | [**PtsV2PaymentsPost201Response1PaymentInformationBankAccount**](PtsV2PaymentsPost201Response1PaymentInformationBankAccount.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1PaymentInformationBankAccount
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ibanSuffix** | **String** | The description for this field is not available. | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1PaymentInformationPaymentType
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **method** | [**PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod**](PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1PaymentInformationPaymentTypeMethod
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | The payment channel that facilitates the transactions. This parameter can be used if the payment channels are listed on the merchant’s site, and the payment channel is known. Possible Values: #### Via PPRO - &#x60;alfaVa&#x60; - &#x60;kredivo&#x60; - &#x60;consumerBarCode&#x60; - &#x60;merchantQrCode&#x60; - &#x60;dokuWallet&#x60; | [optional]
7
+
8
+
@@ -0,0 +1,13 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1ProcessorInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \&quot;Network Transaction Identifiers\&quot; in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID &#x3D; 66012345 - Shift number &#x3D; 001 - Batch number &#x3D; 069 - Transaction number &#x3D; 003 | [optional]
7
+ **tradeNumber** | **String** | The description for this field is not available. | [optional]
8
+ **rawResponse** | **String** | This field is set to the value of failure reason returned by the processor. | [optional]
9
+ **responseCode** | **String** | This field is set to the value of response code returned by the processor. | [optional]
10
+ **sellerProtection** | [**PtsV2PaymentsPost201Response1ProcessorInformationSellerProtection**](PtsV2PaymentsPost201Response1ProcessorInformationSellerProtection.md) | | [optional]
11
+ **avs** | [**PtsV2PaymentsPost201Response1ProcessorInformationAvs**](PtsV2PaymentsPost201Response1ProcessorInformationAvs.md) | | [optional]
12
+
13
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1ProcessorInformationAvs
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **codeRaw** | **String** | AVS result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of AVS. Use for debugging purposes only. Returned by authorization service. | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.PtsV2PaymentsPost201Response1ProcessorInformationSellerProtection
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **eligibilty** | **String** | The level of seller protection in force for the transaction. Possible values: - &#x60;ELIGIBLE&#x60; - &#x60;PARTIALLY_ELIGIBLE&#x60; - &#x60;INELIGIBLE&#x60; | [optional]
7
+
8
+
@@ -33,5 +33,7 @@ Name | Type | Description | Notes
33
33
  **retrievalReferenceNumber** | **String** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [optional]
34
34
  **paymentUrl** | **String** | Direct the customer to this URL to complete the payment. | [optional]
35
35
  **completeUrl** | **String** | The redirect URL for forwarding the consumer to complete page. This redirect needed by PSP to track browser information of consumer. PSP then redirect consumer to merchant success URL. | [optional]
36
+ **signature** | **String** | | [optional]
37
+ **publicKey** | **String** | | [optional]
36
38
 
37
39
 
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
  **localTime** | **String** | The customer&#39;s local time (&#x60;hh:mm:ss&#x60;), which is calculated from the transaction request time and the customer&#39;s billing address. For details, see the &#x60;score_time_local&#x60; field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) | [optional]
12
12
  **score** | [**PtsV2PaymentsPost201ResponseRiskInformationScore**](PtsV2PaymentsPost201ResponseRiskInformationScore.md) | | [optional]
13
13
  **ipAddress** | [**PtsV2PaymentsPost201ResponseRiskInformationIpAddress**](PtsV2PaymentsPost201ResponseRiskInformationIpAddress.md) | | [optional]
14
- **providers** | [**PtsV2PaymentsPost201ResponseRiskInformationProviders**](PtsV2PaymentsPost201ResponseRiskInformationProviders.md) | | [optional]
14
+ **providers** | **{String: {String: String}}** | Name of the 3rd party provider, for example, Emailage. For all possible values, see the &#x60;decision_provider_#_name&#x60; field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** &gt; **Documentation** &gt; **Guides** &gt; _Decision Manager Using the SCMP API Developer Guide_ (PDF link). | [optional]
15
15
  **travel** | [**PtsV2PaymentsPost201ResponseRiskInformationTravel**](PtsV2PaymentsPost201ResponseRiskInformationTravel.md) | | [optional]
16
16
 
17
17
 
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **submitTimeUtc** | **String** | Time of request in UTC. Format: &#x60;YYYY-MM-DDThh:mm:ssZ&#x60; **Example** &#x60;2016-08-11T22:47:57Z&#x60; equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The &#x60;T&#x60; separates the date and the time. The &#x60;Z&#x60; indicates UTC. Returned by Cybersource for all services. | [optional]
9
9
  **status** | **String** | The status of the submitted transaction. Possible values: - PENDING | [optional]
10
10
  **reconciliationId** | **String** | Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response. | [optional]
11
- **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional]
11
+ **clientReferenceInformation** | [**PtsV2PaymentsRefundPost201ResponseClientReferenceInformation**](PtsV2PaymentsRefundPost201ResponseClientReferenceInformation.md) | | [optional]
12
12
  **refundAmountDetails** | [**PtsV2PaymentsRefundPost201ResponseRefundAmountDetails**](PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.md) | | [optional]
13
13
  **processorInformation** | [**PtsV2PaymentsRefundPost201ResponseProcessorInformation**](PtsV2PaymentsRefundPost201ResponseProcessorInformation.md) | | [optional]
14
14
  **orderInformation** | [**PtsV2PaymentsRefundPost201ResponseOrderInformation**](PtsV2PaymentsRefundPost201ResponseOrderInformation.md) | | [optional]
@@ -0,0 +1,11 @@
1
+ # CyberSource.PtsV2PaymentsRefundPost201ResponseClientReferenceInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional]
7
+ **submitLocalDateTime** | **String** | Date and time at your physical location. Format: &#x60;YYYYMMDDhhmmss&#x60;, where YYYY &#x3D; year, MM &#x3D; month, DD &#x3D; day, hh &#x3D; hour, mm &#x3D; minutes ss &#x3D; seconds #### PIN Debit Optional field for PIN Debit purchase and credit requests. | [optional]
8
+ **ownerMerchantId** | **String** | Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. | [optional]
9
+ **returnReconciliationId** | **String** | A new ID which is created for refund | [optional]
10
+
11
+
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **refundAmount** | **String** | Total amount of the refund. | [optional]
7
+ **creditAmount** | **String** | Amount that was credited to the cardholder’s account. Returned by PIN debit credit. | [optional]
7
8
  **currency** | **String** | Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (&#x60;reversalInformation&#x60;) or a capture (&#x60;processingOptions.capture&#x60; is set to &#x60;true&#x60;), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the &#x60;currency&#x60; field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional]
8
9
 
9
10
 
@@ -0,0 +1,10 @@
1
+ # CyberSource.Ptsv1pushfundstransferAggregatorInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. FDC Compass This value must consist of uppercase letters. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - &#x60;Record&#x60;: CP01 TCR6 - &#x60;Position&#x60;: 95-105 - &#x60;Field&#x60;: Market Identifier / Payment Facilitator ID | [optional]
7
+ **name** | **String** | Your payment aggregator business name. Visa Platform COnnect With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in Credit Card Services Using the SCMP API. | [optional]
8
+ **subMerchant** | [**Ptsv1pushfundstransferAggregatorInformationSubMerchant**](Ptsv1pushfundstransferAggregatorInformationSubMerchant.md) | | [optional]
9
+
10
+
@@ -0,0 +1,16 @@
1
+ # CyberSource.Ptsv1pushfundstransferAggregatorInformationSubMerchant
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The ID you assigned to your sub-merchant. FDC Compass: This value must consist of uppercase characters. Visa Platform Connect with Mastercard: String (15) FDC Compass: String (20) | [optional]
7
+ **name** | **String** | Sub-merchant’s business name. Visa Platform Connect With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional]
8
+ **address1** | **String** | First line of the sub-merchant’s street address. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional]
9
+ **locality** | **String** | Sub-merchant’s city. For processor-specific details, see submerchant_city request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional]
10
+ **administrativeArea** | **String** | Sub-merchant’s state or province. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional]
11
+ **postalCode** | **String** | Partial postal code for the sub-merchant’s address. For processor-specific details, see submerchant_postal_code request field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field does not map to the TC 33 capture file5. FDC Compass This value must consist of uppercase characters. | [optional]
12
+ **country** | **String** | Sub-merchant’s country. Use the ISO Standard numeric Country Codes. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Visa Platform Connect The value for this field does not map to the TC 33 capture file. FDC Compass This value must consist of uppercase characters. | [optional]
13
+ **email** | **String** | Sub-merchant’s email address. CyberSource through VisaNet | With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address - Note The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional]
14
+ **phoneNumber** | **String** | Sub-merchant’s telephone number. Maximum length for procesors Visa Platform Connect: 20 FDC Compass: 13 FDC Compass This value must consist of uppercase characters. Use one of these recommended formats: NNN-NNN-NNNN NNN-AAAAAAA | [optional]
15
+
16
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.Ptsv1pushfundstransferClientReferenceInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional]
7
+ **applicationName** | **String** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional]
8
+ **applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction. | [optional]
9
+ **applicationUser** | **String** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional]
10
+
11
+
@@ -0,0 +1,9 @@
1
+ # CyberSource.Ptsv1pushfundstransferMerchantDefinedInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference merchantDefinedInformation[1].key. For Mastercard Send: Name to be displayed in the reconciliation report for this disbursement. This value will appear as a header in the column name of the report. | [optional]
7
+ **value** | **String** | The value you assign for your merchant-defined data field. For details, see merchant_defined_data1 field description in the Credit Card Services Using the SCMP API Guide. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver&#39;s license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant&#39;s account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. For Mastercard Send: Value to be displayed in the reconciliation report for this disbursement. | [optional]
8
+
9
+
@@ -0,0 +1,11 @@
1
+ # CyberSource.Ptsv1pushfundstransferMerchantInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **categoryCode** | **Number** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field description in Credit Card Services Using the SCMP API. Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR4 Position: 150-153 Field: Merchant Category Code | [optional]
7
+ **submitLocalDateTime** | **String** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional]
8
+ **vatRegistrationNumber** | **String** | Your government-assigned tax identification number. Visa Platform Connect: max length is 20 | [optional]
9
+ **merchantDescriptor** | [**Ptsv1pushfundstransferMerchantInformationMerchantDescriptor**](Ptsv1pushfundstransferMerchantInformationMerchantDescriptor.md) | | [optional]
10
+
11
+
@@ -0,0 +1,13 @@
1
+ # CyberSource.Ptsv1pushfundstransferMerchantInformationMerchantDescriptor
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **administrativeArea** | **String** | The state where the merchant is located. See https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf Note This field is supported only for businesses located in the U.S. or Canada. | [optional]
7
+ **contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see merchant_descriptor_contact field description in Credit Card Services Using the SCMP API.--&gt; Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: FDC Compass (13) Chase Paymentech (13). | [optional]
8
+ **country** | **String** | Merchant&#39;s country. Country code for your business location. Use the ISO Standard Alpha Country Codes This value might be displayed on the cardholder’s statement. See https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include merchantInformation.merchantDescriptor.administrativeArea. | [optional]
9
+ **locality** | **String** | Merchant&#39;s City. City for your business location. This value might be displayed on the cardholder’s statement. | [optional]
10
+ **name** | **String** | Merchant&#39;s business name. This name is displayed on the cardholder’s statement. Chase Paymentech, Visa Platform Connect: length 22 | [optional]
11
+ **postalCode** | **String** | Merchant&#39;s postal code. This value might be displayed on the cardholder’s statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: 12345-6789 If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: A1B 2C3 | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # CyberSource.Ptsv1pushfundstransferOrderInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amountDetails** | [**Ptsv1pushfundstransferOrderInformationAmountDetails**](Ptsv1pushfundstransferOrderInformationAmountDetails.md) | |
7
+ **isCryptocurrencyPurchase** | **String** | This indicates that the funds transfer is for a crypto currency transaction. Optional Y/y, true N/n, false | [optional]
8
+ **surcharge** | [**Ptsv1pushfundstransferOrderInformationSurcharge**](Ptsv1pushfundstransferOrderInformationSurcharge.md) | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # CyberSource.Ptsv1pushfundstransferOrderInformationAmountDetails
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. The disbursement amount. Numeric integer, 1-999999999999. The decimal point is implied based on the relevant currency exponent. For example, a US Dollar $53 amount is a value of 5300. Processor Amount Ranges: Visa Platform Connect: .01-9999999999.99 Mastercard Send: 1-9999999999.99 FDC Compass: .01- 9999999999.99 Chase Paymentech: .01-9999999999.99 |
7
+ **currency** | **String** | Use a 3-character alpha currency code for currency of the sender. ISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf Currency must be supported by the processor. |
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferOrderInformationSurcharge
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer. If the amount is negative, then it is a credit for the customer. NOTE: This field is supported only for Visa Platform Connect | [optional]
7
+
8
+
@@ -0,0 +1,12 @@
1
+ # CyberSource.Ptsv1pushfundstransferPointOfServiceInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. Visa Platform Connect A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. Used by Authorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include pointOfSaleInformation.catLevel. | [optional]
7
+ **catLevel** | **Number** | Type of cardholder-activated terminal. Possible values: - &#x60;1&#x60;: Automated dispensing machine - &#x60;2&#x60;: Self-service terminal - &#x60;3&#x60;: Limited amount terminal - &#x60;4&#x60;: In-flight commerce (IFC) terminal - &#x60;5&#x60;: Radio frequency device - &#x60;6&#x60;: Mobile acceptance terminal - &#x60;7&#x60;: Electronic cash register - &#x60;8&#x60;: E-commerce device at your location - &#x60;9&#x60;: Terminal or cash register that uses a dialup connection to connect to the transaction processing network Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if pointOfSaleInformation.terminalID is included in the request; otherwise, optional. Visa Platform COnnect Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. Nonnegative integer. | [optional]
8
+ **entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - &#x60;contact&#x60;: Read from direct contact with chip card. - &#x60;contactless&#x60;: Read from a contactless interface using chip data. - &#x60;keyed&#x60;: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - &#x60;msd&#x60;: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - &#x60;swiped&#x60;: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. | [optional]
9
+ **pinEntryCapability** | **Number** | PIN Entry Capability - 0 Unknown. - 1 Indicates terminal can accept and forward online PINs. - 2 Indicates terminal cannot accept and forward online PINs. - 8 Terminal PIN pad down. - 9 Reserved for future use. | [optional]
10
+ **terminalCapability** | **Number** | integer [ 1 .. 5 ] POS terminal’s capability. Possible values: - &#x60;1&#x60;: Terminal has a magnetic stripe reader only. - &#x60;2&#x60;: Terminal has a magnetic stripe reader and manual entry capability. - &#x60;3&#x60;: Terminal has manual entry capability only. - &#x60;4&#x60;: Terminal can read chip cards. - &#x60;5&#x60;: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be 4 or 5. Used by Authorization Required for the following processors: Chase Paymentech Solutions Optional for the following processors: Visa Platform Connect | [optional]
11
+
12
+
@@ -0,0 +1,15 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **businessApplicationId** | **String** | Payouts transaction type. Required for Mastercard Send. Valid Values- Visa Platform Connect: - &#x60;AA&#x60;: Account to account. - &#x60;CP&#x60;: Card bill payment - &#x60;FD&#x60;: Funds disbursement (general) - &#x60;GD&#x60;: Government disbursement - &#x60;MD&#x60;: Merchant disbursement (acquirers or aggregators settling to merchants). - &#x60;PP&#x60;: Person to person. - &#x60;TU&#x60;: Top-up for enhanced prepaid loads. Mastercard Send: - &#x60;BB&#x60;: Business to business. - &#x60;BD&#x60;: Business Disbursement - &#x60;CP&#x60;: Card bill payment - &#x60;GD&#x60;: Government disbursement - &#x60;MD&#x60;: Merchant disbursement (acquirers or aggregators settling to merchants). - &#x60;OG&#x60;: Online gambling payout. Chase Paymentech Solutions: - &#x60;AA&#x60;: Account to account. - &#x60;FD&#x60;: Funds disbursement (general) - &#x60;MD&#x60;: Merchant disbursement (acquirers or aggregators settling to merchants). - &#x60;PP&#x60;: Person to person. FDC Compass: - &#x60;BB&#x60;: Business to business. - &#x60;BI&#x60;: Bank-initiated money transfer. - &#x60;FD&#x60;: Funds disbursement (general) - &#x60;GD&#x60;: Government disbursement - &#x60;GP&#x60;: Gambling Payment - &#x60;LO&#x60;: Loyalty Offers - &#x60;MD&#x60;: Merchant disbursement (acquirers or aggregators settling to merchants). - &#x60;MI&#x60;: Merchant initated money transfer - &#x60;OG&#x60;: Online gambling payout. - &#x60;PD&#x60;: Payroll pension disbursement. - &#x60;PP&#x60;: Person to person. - &#x60;WT&#x60;: Wallet transfer. | [optional]
7
+ **commerceIndicator** | **String** | Type of transaction. Value for an OCT transaction: internet For details, see the e_commerce_indicator field description in Payouts Using the SCMP API. |
8
+ **networkRoutingOrder** | **String** | Visa Platform Connect This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer’s preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer’s routing priorities. For details, see the network_order field description in BIN Lookup Service Using the SCMP API. | [optional]
9
+ **payoutsOptions** | [**Ptsv1pushfundstransferProcessingInformationPayoutsOptions**](Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md) | | [optional]
10
+ **purposeOfPayment** | **String** | This will send purpose of funds code for original credit transactions (OCTs). Visa Platform Connect (VPC) This will send purpose of transaction code for original credit transactions (OCTs). Purpose of Payment codes are defined by the recipient issuer&#39;s country and vary by country. Mastercard Send: - &#x60;00&#x60;: Family Support - &#x60;01&#x60;: Regular Labor Transfers (expatriates), - &#x60;02&#x60;: Travel &amp; Tourism - &#x60;03&#x60;: Education - &#x60;04&#x60;: Hospitalization &amp; Medical Treatment, - &#x60;05&#x60;: Emergency Need - &#x60;06&#x60;: Savings - &#x60;07&#x60;: Gifts - &#x60;08&#x60;: Other - &#x60;09&#x60;: Salary - &#x60;10&#x60;: Crowd lending - &#x60;11&#x60;: Crypto currency - &#x60;12&#x60;: Refund to original card - &#x60;13&#x60;: Refund to new card | [optional]
11
+ **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. For Payouts: max length for FDCCompass is String (22). | [optional]
12
+ **recurringOptions** | [**Ptsv1pushfundstransferProcessingInformationRecurringOptions**](Ptsv1pushfundstransferProcessingInformationRecurringOptions.md) | | [optional]
13
+ **transactionReason** | **String** | Transaction reason code. This field applies only to Visa Platform Connect | [optional]
14
+
15
+
@@ -0,0 +1,9 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingInformationPayoutsOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **accountFundingReferenceId** | **String** | Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. Applicable only for Visa Platform Connect | [optional]
7
+ **retrievalReferenceNumber** | **String** | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Format: Positions 1-4: The yddd equivalent of the date, where y &#x3D; 0-9 and ddd &#x3D; 001 – 366. Positions 5-12: A unique identification number generated by the merchant Applicable only for Visa Platform Connect | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingInformationRecurringOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **loanPayment** | **Boolean** | boolean Default: false Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: true: Loan payment false: (default) Not a loan payment This field applies only to FDC Compass | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **fundingOptions** | [**Ptsv1pushfundstransferProcessingOptionsFundingOptions**](Ptsv1pushfundstransferProcessingOptionsFundingOptions.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptions
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **initiator** | [**Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator**](Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator.md) | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferProcessingOptionsFundingOptionsInitiator
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | **String** | Visa Platform Connect : This API will contain a code that denotes whether the customer identification data belongs to the sender or the recipient. The valid values are: - &#x60;S&#x60; (Payer (sender)) - &#x60;R&#x60; (Payee (recipient)) This field applies only to Visa Platform Connect | [optional]
7
+
8
+
@@ -0,0 +1,21 @@
1
+ # CyberSource.Ptsv1pushfundstransferRecipientInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **paymentInformation** | [**Ptsv1pushfundstransferRecipientInformationPaymentInformation**](Ptsv1pushfundstransferRecipientInformationPaymentInformation.md) | | [optional]
7
+ **address1** | **String** | First line of the recipient&#39;s address. Required for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional]
8
+ **address2** | **String** | Second line of the recipient&#39;s address Optional for Mastercard Send. This field is not supported for Visa Platform Connect. | [optional]
9
+ **locality** | **String** | Recipient city. Required for Mastercard Send. | [optional]
10
+ **postalCode** | **String** | Recipient postal code. For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example &#39;63368&#39;, &#39;63368-5555&#39;. For other regions, this can be alphanumeric, length 1-10. Mastercard Send: Required for recipients in Canada and Canadian issued cards. | [optional]
11
+ **administrativeArea** | **String** | The recipient&#39;s province, state or territory. Conditional, required if recipient&#39;s country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO. Required only for FDCCompass. This field is not supported for Visa Platform Connect. | [optional]
12
+ **country** | **String** | Recipient country code. Use the ISO Standard Alpha Country Codes. https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf Required for Mastercard Send. | [optional]
13
+ **firstName** | **String** | First name of recipient. Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional]
14
+ **middleName** | **String** | Sender’s middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional]
15
+ **middleInitial** | **String** | Middle Initial of recipient. This field is supported by FDC Compass. | [optional]
16
+ **lastName** | **String** | Last name of recipient. Visa Platform Connect (14) Paymentech (30) Mastercard Send (40) This field is required for Mastercard Send. | [optional]
17
+ **dateOfBirth** | **String** | Recipient date of birth in YYYYMMDD format. | [optional]
18
+ **phoneNumber** | **String** | Recipient phone number. This field is supported by FDC Compass. Mastercard Send: Max length is 15 with no dashes or spaces. | [optional]
19
+ **personalIdentification** | [**Ptsv1pushfundstransferRecipientInformationPersonalIdentification**](Ptsv1pushfundstransferRecipientInformationPersonalIdentification.md) | | [optional]
20
+
21
+
@@ -0,0 +1,8 @@
1
+ # CyberSource.Ptsv1pushfundstransferRecipientInformationPaymentInformation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **card** | [**Ptsv1pushfundstransferRecipientInformationPaymentInformationCard**](Ptsv1pushfundstransferRecipientInformationPaymentInformationCard.md) | | [optional]
7
+
8
+