This is an old revision of the document!

PayOutstandingBalanceRequest Call Reference

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.

View:

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.

XML

<?xml version="1.0" encoding="utf-8"?>
    <PayOutstandingBalanceRequest>
        <Username>string</Username>	
        <Token>string</Token>
        <Guid>string</Guid>
        <CreditCard>
             <CardNumber>string</CardNumber>
             <CardType>string</CardType>
             <ExpMonth>string</ExpMonth>
             <ExpYear>string</ExpYear>
             <SecureCode>string</SecureCode>
        </CreditCard>
        <Customer>
               <Email>string</Email>
               <FirstName>string</FirstName>
               <LastName>string</LastName>
               <BillingAddress>
                      <FirstName>string</FirstName>
                      <LastName>string</LastName>
                      <Company>string</Company>
                      <Address>string</Address>
                      <Address2>string</Address2>
                      <City>string</City>
                      <Region>string</Region>
                      <PostalCode>string</PostalCode>
                      <Country>string</Country>
                      <Phone>string</Phone>
               </BillingAddress>
               <ShippingAddress>
                      <FirstName>string</FirstName>
                      <LastName>string</LastName>
                      <Company>string</Company>
                      <Address>string</Address>
                      <Address2>string</Address2>
                      <City>string</City>
                      <Region>string</Region>
                      <PostalCode>string</PostalCode>
                      <Country>string</Country>
                      <Phone>string</Phone>
               </ShippingAddress>
               <Password>string</Password>
               <Account>string</Account>
        </Customer>		
    </PayOutstandingBalanceRequest>

Elements

Name	Type	Occurrence	Meaning
PayOutstandingBalanceRequest	container	required	Parent Element
Username	string	required	Merchant API username (this is not your SubscriptionBridge login id)
Token	string	required	Your application's security token. view also: How to create a token
Guid	string	required	The Subscription Unique ID
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
Customer	container	required	Parent Element
Customer/Email	string	required	customer email address
Customer/FirstName	string	required	customer first name
Customer/LastName	string	required	customer last name
Customer/BillingAddress	container	required	Parent Element
Customer/BillingAddress/FirstName	string	required	billing first name
Customer/BillingAddress/LastName	string	required	billing last name
Customer/BillingAddress/Company	string	optional	billing company
Customer/BillingAddress/Address	string	required	billing address
Customer/BillingAddress/Address2	string	optional	billing address line 2
Customer/BillingAddress/City	string	required	billing city
Customer/BillingAddress/Region	string	conditional	billing state code or province
Customer/BillingAddress/PostalCode	string	conditional	billing postal code
Customer/BillingAddress/Country	string	required	billing country
Customer/BillingAddress/Phone	string	required	billing phone
Customer/ShippingAddress	container	required	Parent Element
Customer/ShippingAddress/FirstName	string	required	shipping first name
Customer/ShippingAddress/LastName	string	required	shipping last name
Customer/ShippingAddress/Company	optional	required	shipping company
Customer/ShippingAddress/Address	string	required	shipping address
Customer/ShippingAddress/Address2	optional	required	shipping address line 2
Customer/ShippingAddress/City	string	required	shipping city
Customer/ShippingAddress/Region	conditional	required	shipping state code or province
Customer/ShippingAddress/PostalCode	conditional	required	shipping postal code
Customer/ShippingAddress/Country	string	required	shipping country
Customer/ShippingAddress/Phone	optional	required	shipping phone

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.

XML

<?xml version="1.0" encoding="utf-8"?>
    <PayOutstandingBalanceResponse>
        <Ack>string</Ack> 
	<Timestamp>timestamp</Timestamp>
    </PayOutstandingBalanceResponse>

Elements

Name	Type	Occurrence	Meaning
PayOutstandingBalanceResponse	container	required	Parent Element
Ack	string	always	Success, Error, or Warning
Timestamp	string	always	All responses return the official SB time stamp in UTC/GMT

SubscriptionBridge: recurring billing and subscription management system - Documentation

Table of Contents

PayOutstandingBalanceRequest Call Reference