Billhighway Cloud API

<back to all web services

SalesForceCreditCardPaymentCollection

The following routes are available for this service:
POST/api/SalesForce/CreditCardPayment

export class SalesForceCreditCardPaymentReply
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public TransactionId?: string;
    public ErrorCode?: number;
    public ErrorMessage?: string;

    public constructor(init?: Partial<SalesForceCreditCardPaymentReply>) { (Object as any).assign(this, init); }
}

export class SalesForceMemberPaymentInvoiceDetail
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public Invoice?: number;
    public AmountPaid?: string;

    public constructor(init?: Partial<SalesForceMemberPaymentInvoiceDetail>) { (Object as any).assign(this, init); }
}

export class SalesForceCreditCardPayment
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public Amount?: string;
    public AutoPay?: boolean;
    public CurrencyType?: string;
    public Country?: string;
    public CardReferenceOrCardNumber?: string;
    public StoreCardInfo?: boolean;
    public Address1?: string;
    public Address2?: string;
    public BillingCity?: string;
    public BillingState?: string;
    public PreferredEmailAddress?: string;
    public Memo?: string;
    public OpportunityId?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public Cvv?: string;
    public PostalCode?: string;
    public Location?: string;
    public NameOnCard?: string;
    public CardType?: string;
    public InvoiceList?: SalesForceMemberPaymentInvoiceDetail[];

    public constructor(init?: Partial<SalesForceCreditCardPayment>) { (Object as any).assign(this, init); }
}

export class SalesForceCreditCardPaymentCollection
{
    public SalesForceCreditCardPaymentList?: SalesForceCreditCardPayment[];

    public constructor(init?: Partial<SalesForceCreditCardPaymentCollection>) { (Object as any).assign(this, init); }
}

TypeScript SalesForceCreditCardPaymentCollection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SalesForce/CreditCardPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SalesForceCreditCardPaymentList: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			BhUserId: 0,
			Amount: String,
			AutoPay: False,
			CurrencyType: String,
			Country: String,
			CardReferenceOrCardNumber: String,
			StoreCardInfo: False,
			Address1: String,
			Address2: String,
			BillingCity: String,
			BillingState: String,
			PreferredEmailAddress: String,
			Memo: String,
			OpportunityId: String,
			ExpMonth: 0,
			ExpYear: 0,
			Cvv: String,
			PostalCode: String,
			Location: String,
			NameOnCard: String,
			CardType: String,
			InvoiceList: 
			[
				{
					ClassName: String,
					UniqueId: String,
					CreatedDateTime: 0001-01-01,
					ClientId: 0,
					Invoice: 0,
					AmountPaid: String
				}
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	TransactionId: String,
	ErrorCode: 0,
	ErrorMessage: String
}