Billhighway Cloud API

<back to all web services

HeldPaymentChargeRq

The following routes are available for this service:
POST/integrations/api/{integrationType}/heldpayment/charge
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.DTO.HeldPayments.Api.Request;
using BH.CloudAPI.DTO.HeldPayments;
using BH.CloudAPI.DTO.HeldPayments.Api.Response;
using BH.CloudAPI.DTO.HeldPayments.Api;
using BH.CloudAPI.DTO.Charges.Api;
using BH.CloudAPI.Common4.DTO;

namespace BH.CloudAPI.Common4.DTO
{
    public partial class AttributeItem
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

namespace BH.CloudAPI.DTO.Charges.Api
{
    public partial class AchChargeVerificationResult
    {
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string Result { get; set; }
    }

    public partial class CreditCardBillingAddressItem
    {
        public CreditCardBillingAddressItem()
        {
            Attributes = new List<AttributeItem>{};
        }

        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string City { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string Region { get; set; }
        public virtual string Country { get; set; }
        public virtual List<AttributeItem> Attributes { get; set; }
    }

    public partial class CreditCardChargeVerificationResult
    {
        public virtual bool NetworkVerificationAttempted { get; set; }
        public virtual string CvvVerificationResult { get; set; }
        public virtual string AddressVerificationResult { get; set; }
        public virtual string PostalCodeVerificationResult { get; set; }
    }

}

namespace BH.CloudAPI.DTO.HeldPayments
{
    public partial class HeldPaymentChargeItem
    {
        public virtual string Type { get; set; }
        public virtual string Description { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string ClientInvoiceId { get; set; }
        public virtual int ClientInvoiceOwnerTypeId { get; set; }
    }

    public partial class HeldPaymentGatewaySaleResponse
    {
        public virtual string FailureType { get; set; }
        public virtual bool IsDuplicate { get; set; }
        public virtual bool IsSuccessful { get; set; }
        public virtual string ErrorCode { get; set; }
        public virtual string Message { get; set; }
        public virtual int GatewayId { get; set; }
        public virtual string ConfirmationNumber { get; set; }
        public virtual string NetworkTransactionId { get; set; }
    }

}

namespace BH.CloudAPI.DTO.HeldPayments.Api
{
    public partial class HeldPaymentAchChargeDetails
    {
        public virtual string AccountType { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumberLast4 { get; set; }
        public virtual string BankName { get; set; }
        public virtual AchChargeVerificationResult VerificationResult { get; set; }
    }

    public partial class HeldPaymentChargeDetails
    {
        public virtual string PaymentType { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string IntegrationType { get; set; }
        public virtual string Currency { get; set; }
        public virtual HeldPaymentCreditCardChargeDetails CardDetails { get; set; }
        public virtual HeldPaymentAchChargeDetails AchDetails { get; set; }
    }

    public partial class HeldPaymentCreditCardChargeDetails
    {
        public virtual string CardType { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string Last4 { get; set; }
        public virtual CreditCardBillingAddressItem Address { get; set; }
        public virtual CreditCardChargeVerificationResult VerificationResult { get; set; }
    }

}

namespace BH.CloudAPI.DTO.HeldPayments.Api.Request
{
    public partial class HeldPaymentChargeRq
        : IChargeRequest
    {
        public HeldPaymentChargeRq()
        {
            ChargeItems = new List<HeldPaymentChargeItem>{};
        }

        public virtual string integrationType { get; set; }
        public virtual int NationalId { get; set; }
        public virtual int ChapterId { get; set; }
        public virtual long StoredAccountId { get; set; }
        public virtual int ContextIntegrationPartnerId { get; set; }
        public virtual int CallerIntegrationPartnerId { get; set; }
        public virtual int AuthenticationId { get; set; }
        public virtual string ChargeType { get; set; }
        public virtual string Token { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string Description { get; set; }
        public virtual int CreatedById { get; set; }
        public virtual long TransactionId { get; set; }
        public virtual bool StoreChargeAccount { get; set; }
        public virtual List<HeldPaymentChargeItem> ChargeItems { get; set; }
        public virtual int CreatedBy { get; set; }
    }

}

namespace BH.CloudAPI.DTO.HeldPayments.Api.Response
{
    public partial class HeldPaymentChargeRs
    {
        public HeldPaymentChargeRs()
        {
            ChargeItems = new List<HeldPaymentChargeItem>{};
        }

        public virtual string TransactionId { get; set; }
        public virtual long StoredAccountId { get; set; }
        public virtual int NationalId { get; set; }
        public virtual int ChapterId { get; set; }
        public virtual string ChargeType { get; set; }
        public virtual string IntegrationType { get; set; }
        public virtual int ContextIntegrationPartnerId { get; set; }
        public virtual int CallerIntegrationPartnerId { get; set; }
        public virtual HeldPaymentGatewaySaleResponse GatewayResponse { get; set; }
        public virtual HeldPaymentChargeDetails ChargeDetails { get; set; }
        public virtual List<HeldPaymentChargeItem> ChargeItems { get; set; }
    }

}

C# HeldPaymentChargeRq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /integrations/api/{integrationType}/heldpayment/charge HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"integrationType":"String","NationalId":0,"ChapterId":0,"StoredAccountId":0,"ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"AuthenticationId":0,"ChargeType":"String","Token":"String","Amount":0,"Description":"String","CreatedById":0,"TransactionId":0,"StoreChargeAccount":false,"ChargeItems":[{"Type":"String","Description":"String","Amount":0,"ClientInvoiceId":"String","ClientInvoiceOwnerTypeId":0}],"CreatedBy":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TransactionId":"String","StoredAccountId":0,"NationalId":0,"ChapterId":0,"ChargeType":"String","IntegrationType":"String","ContextIntegrationPartnerId":0,"CallerIntegrationPartnerId":0,"GatewayResponse":{"FailureType":"String","IsDuplicate":false,"IsSuccessful":false,"ErrorCode":"String","Message":"String","GatewayId":0,"ConfirmationNumber":"String","NetworkTransactionId":"String"},"ChargeDetails":{"PaymentType":"String","Amount":0,"IntegrationType":"String","Currency":"String","CardDetails":{"CardType":"String","ExpMonth":0,"ExpYear":0,"Last4":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]},"VerificationResult":{"NetworkVerificationAttempted":false,"CvvVerificationResult":"String","AddressVerificationResult":"String","PostalCodeVerificationResult":"String"}},"AchDetails":{"AccountType":"String","RoutingNumber":"String","AccountNumberLast4":"String","BankName":"String","VerificationResult":{"NetworkVerificationAttempted":false,"Result":"String"}}},"ChargeItems":[{"Type":"String","Description":"String","Amount":0,"ClientInvoiceId":"String","ClientInvoiceOwnerTypeId":0}]}