UNPKG

cybersource-rest-client

Version:

Node.js SDK for the CyberSource REST API

23 lines (19 loc) • 3.51 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# CyberSource.GetSubscriptionsPaymentsResponseSubscriptionPayment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Identifier assigned by Recurring Billing to uniquely reference this billing cycle's payment, distinct from the Cybersource transactionID. | [optional] **status** | **String** | The current status of the payment. Possible values: - SCHEDULED - PAID - FAILED - SKIPPED - SCHEDULED_SKIPPED | [optional] **paymentType** | **String** | The type of payment. Possible values: - STANDARD - RETRY | [optional] **transactionID** | **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] **_date** | **Date** | The date and time of the payment processing. | [optional] **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 (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), 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. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. | [optional] **billingStartDate** | **Date** | The start date of the billing cycle for this payment. | [optional] **billingEndDate** | **Date** | The end date of the billing cycle for this payment. | [optional] **billingCycle** | **String** | The billing cycle number. | [optional] **paymentNumber** | **String** | The sequential number of the payment in the subscription. | [optional] **billingAmount** | **String** | The amount billed for this payment. | [optional] **setupFee** | **String** | The setup fee associated with the payment. | [optional] **surchargeAmount** | **String** | The surcharge amount, if any. | [optional] **surchargeDescription** | **String** | The description for the surcharge. | [optional] **modifiable** | **Boolean** | Indicates if the payment is modifiable, meaning it can be skipped or restored. | [optional]