Billhighway Cloud API

<back to all web services

AchDonation

The following routes are available for this service:
POST/v1.2/payments/ach
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class AchDonation extends AchDonation implements ICanBeRecurring, IReturnLegacyException
    {
        
    }

    @DataContract(Namespace="www.billhighway.com/api")
    public static class LegacyApiResponse implements IHaveErrorField
    {
        @DataMember
        public BigDecimal amount = null;

        @DataMember
        public String confirmationNumber = null;

        @DataMember
        public String responseCode = null;

        @DataMember
        public String responseDescription = null;

        @DataMember
        public ResultCode resultCode = null;
        
        public BigDecimal getAmount() { return amount; }
        public LegacyApiResponse setAmount(BigDecimal value) { this.amount = value; return this; }
        public String getConfirmationNumber() { return confirmationNumber; }
        public LegacyApiResponse setConfirmationNumber(String value) { this.confirmationNumber = value; return this; }
        public String getResponseCode() { return responseCode; }
        public LegacyApiResponse setResponseCode(String value) { this.responseCode = value; return this; }
        public String getResponseDescription() { return responseDescription; }
        public LegacyApiResponse setResponseDescription(String value) { this.responseDescription = value; return this; }
        public ResultCode getResultCode() { return resultCode; }
        public LegacyApiResponse setResultCode(ResultCode value) { this.resultCode = value; return this; }
    }

    public static enum ResultCode
    {
        @SerializedName("0") Success(0),
        @SerializedName("-7") Duplicate(-7),
        @SerializedName("-6") NotAvailable(-6),
        @SerializedName("-5") NotFound(-5),
        @SerializedName("-4") GeneralError(-4),
        @SerializedName("-3") UnexpectedError(-3),
        @SerializedName("-2") CreditCardDeclined(-2),
        @SerializedName("-1") DataValidationFailure(-1);

        private final int value;
        ResultCode(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java AchDonation 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/ach HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchDonation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AccountNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</AccountNumber>
  <Amount xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</Amount>
  <CheckNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</CheckNumber>
  <ClientId xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</ClientId>
  <EmailAddress xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</EmailAddress>
  <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>
  <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>
  <PayerName xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</PayerName>
  <RoutingNumber xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</RoutingNumber>
</AchDonation>
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>