Billhighway Cloud API

<back to all web services

CreditCardDonation

The following routes are available for this service:
POST/v1.2/payments/creditcard
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common;

namespace BH.CloudAPI.Common
{
    [DataContract(Namespace="www.billhighway.com/api")]
    public partial class LegacyApiResponse
        : IHaveErrorField
    {
        [DataMember]
        public virtual decimal? amount { get; set; }

        [DataMember]
        public virtual string confirmationNumber { get; set; }

        [DataMember]
        public virtual string responseCode { get; set; }

        [DataMember]
        public virtual string responseDescription { get; set; }

        [DataMember]
        public virtual ResultCode resultCode { get; set; }
    }

    public enum ResultCode
    {
        Success = 0,
        Duplicate = -7,
        NotAvailable = -6,
        NotFound = -5,
        GeneralError = -4,
        UnexpectedError = -3,
        CreditCardDeclined = -2,
        DataValidationFailure = -1,
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class CreditCardDonation
        : CreditCardDonation, ICanBeRecurring, IReturnLegacyException
    {
    }

}

C# CreditCardDonation DTOs

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

HTTP + XML

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

POST /v1.2/payments/creditcard HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreditCardDonation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <Address xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Address>
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <CardNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CardNumber>
  <City xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</City>
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ClientId>
  <Cvv xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Cvv>
  <EmailAddress xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</EmailAddress>
  <ExpMonth xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ExpMonth>
  <ExpYear xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ExpYear>
  <GroupId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</GroupId>
  <Memo xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Memo>
  <NameOnCard xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NameOnCard>
  <NumberOfOccurences xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</NumberOfOccurences>
  <Occurs xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Occurs>
  <Phone xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</Phone>
  <PostalCode xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</PostalCode>
  <State xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</State>
</CreditCardDonation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LegacyApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="www.billhighway.com/api">
  <amount>0</amount>
  <confirmationNumber>String</confirmationNumber>
  <responseCode>String</responseCode>
  <responseDescription>String</responseDescription>
  <resultCode>Success</resultCode>
</LegacyApiResponse>