SubscriptionBridge: recurring billing and subscription management system - Documentation

User Tools

Site Tools

You are here: SubscriptionBridge Documentation » API Documentation: Getting Started » API Call Reference » PayOutstandingBalanceRequest
Trace: • GetSubscriptionHistoryRequest • Subscription Management API: what you can and cannot do • ActivationRequest
developer_guide:call_reference:payoutstandingbalancerequest

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
developer_guide:call_reference:payoutstandingbalancerequest [2012/02/25 20:51] – created mattdeveloper_guide:call_reference:payoutstandingbalancerequest [2012/02/25 23:51] (current) – [PayOutstandingBalanceRequest Call Reference] matt
Line 1: Line 1:
-====== PayOutstandingBalanceRequest Call Reference ======+====== PayOutstandingBalanceRequest ======
  
-PayOutstandingBalanceRequest allows you to submit a payment to apply to the current account balance. It is recommended that you first call "GetSubscriptionDetails" to obtain the current outstanding balance.+==== Overview ====
  
-**View:**+**PayOutstandingBalanceRequest** allows you to submit a payment to apply to the current account balance. It is recommended that you first call "GetSubscriptionDetails" to obtain the current outstanding balance. 
 + 
 +**Learn More:**
  
   * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]     * [[:developer_guide:developer_guide#using-the-apis|Using the APIs]]  
Line 9: Line 11:
   * [[:developer_guide:developer_guide#error-codes|Error Codes]]    * [[:developer_guide:developer_guide#error-codes|Error Codes]] 
   * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]]    * [[:developer_guide:developer_guide#troubleshooting|Troubleshooting]] 
 +
  
  
 ===== PayOutstandingBalanceRequest ===== ===== PayOutstandingBalanceRequest =====
- 
-==== Overview ==== 
- 
-The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, scroll down to find it in the table below the box. 
  
  
Line 75: Line 74:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| PayOutstandingBalanceRequest | container | required | Parent Element | +| **PayOutstandingBalanceRequest** | container | required | Parent Element | 
-| Username | string | required | Merchant API username (this is not your SubscriptionBridge login id) | +| Username | string | required | Merchant API Username (Not your Merchant Center login) | 
-| Token | string | required | Your application's security token. view also: How to create a token | +| Token| string | required | Hash of API Username and Password. [[:developer_guide:developer_guide:LinkID|Creating a Token]] | 
-| Guid | string | required | The Subscription Unique ID | +| Guid | string | always | This is the identifier for the subscription and should be referenced in future management requests | 
-| CreditCard | container | required | Parent Element | +| **Customer** | container | required | Parent Element |
-| CreditCard/CardNumber | string | required | valid credit card number | +
-| CreditCard/CardType | string | required | card type (Visa, MasterCard, Discover, Amex)| +
-| CreditCard/ExpMonth | string | required | expiration month in format "mm" | +
-| CreditCard/ExpYear | string | required | expiration year in format "yyyy" | +
-| CreditCard/SecureCode | string | required | 3 or 4 digit security code | +
-| Customer | container | required | Parent Element |+
 | Customer/Email | string | required | customer email address | | Customer/Email | string | required | customer email address |
 | Customer/FirstName | string | required | customer first name | | Customer/FirstName | string | required | customer first name |
 | Customer/LastName | string | required | customer last name | | Customer/LastName | string | required | customer last name |
-| Customer/BillingAddress | container | required | Parent Element |+| **Customer/BillingAddress** | container | required | Parent Element |
 | Customer/BillingAddress/FirstName | string | required | billing first name | | Customer/BillingAddress/FirstName | string | required | billing first name |
 | Customer/BillingAddress/LastName | string | required | billing last name | | Customer/BillingAddress/LastName | string | required | billing last name |
Line 100: Line 93:
 | Customer/BillingAddress/Country | string | required | billing country | | Customer/BillingAddress/Country | string | required | billing country |
 | Customer/BillingAddress/Phone | string | required | billing phone | | Customer/BillingAddress/Phone | string | required | billing phone |
-| Customer/ShippingAddress | container | required | Parent Element |+| **Customer/ShippingAddress** | container | required | Parent Element |
 | Customer/ShippingAddress/FirstName | string | required | shipping first name | | Customer/ShippingAddress/FirstName | string | required | shipping first name |
 | Customer/ShippingAddress/LastName | string | required | shipping last name | | Customer/ShippingAddress/LastName | string | required | shipping last name |
Line 111: Line 104:
 | Customer/ShippingAddress/Country | string | required | shipping country | | Customer/ShippingAddress/Country | string | required | shipping country |
 | Customer/ShippingAddress/Phone | optional | required | shipping phone | | Customer/ShippingAddress/Phone | optional | required | shipping phone |
 +| Customer/Password | string | optional | a password for the customer center, which will allow you to use the auto log in feature to avoid double login |
 +| Customer/Account | string | optional | an account number of the customer in the 3rd party system |
 +| **CreditCard** | container | required | Parent Element |
 +| CreditCard/CardNumber | string | required | valid credit card number |
 +| CreditCard/CardType | string | required | card type (Visa, MasterCard, Discover, Amex)|
 +| CreditCard/ExpMonth | string | required | expiration month in format "mm" |
 +| CreditCard/ExpYear | string | required | expiration year in format "yyyy" |
 +| CreditCard/SecureCode | string | required | 3 or 4 digit security code |
  
  
 ===== PayOutstandingBalanceResponse ===== ===== PayOutstandingBalanceResponse =====
- 
- 
-==== Overview ==== 
- 
-The box below lists all fields that could be included in the call response. To learn more about an individual field or its type, scroll down to find it in the table below the box. 
- 
  
  
Line 140: Line 135:
  
 ^ Name ^ Type ^ Occurrence  ^ Meaning ^ ^ Name ^ Type ^ Occurrence  ^ Meaning ^
-| PayOutstandingBalanceResponse | container | required | Parent Element |      +| **PayOutstandingBalanceResponse** | container | required | Parent Element |      
 | Ack | string | always | Success, Error, or Warning | | Ack | string | always | Success, Error, or Warning |
 | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT | | Timestamp | string | always | All responses return the official SB time stamp in UTC/GMT |
developer_guide/call_reference/payoutstandingbalancerequest.1330221092.txt.gz · Last modified: 2012/02/24 23:00 (external edit)