Billhighway Cloud API

HeldPaymentChargeRq

The following routes are available for this service:
POST	/integrations/api/{integrationType}/heldpayment/charge

namespace BH.CloudAPI.Common4.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type HeldPaymentGatewaySaleResponse() = 
        member val FailureType:String = null with get,set
        member val IsDuplicate:Boolean = new Boolean() with get,set
        member val IsSuccessful:Boolean = new Boolean() with get,set
        member val ErrorCode:String = null with get,set
        member val Message:String = null with get,set
        member val GatewayId:Int32 = new Int32() with get,set
        member val ConfirmationNumber:String = null with get,set
        member val NetworkTransactionId:String = null with get,set

    [<AllowNullLiteral>]
    type AttributeItem() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type CreditCardBillingAddressItem() = 
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val PostalCode:String = null with get,set
        member val Region:String = null with get,set
        member val Country:String = null with get,set
        member val Attributes:ResizeArray<AttributeItem> = new ResizeArray<AttributeItem>() with get,set

    [<AllowNullLiteral>]
    type CreditCardChargeVerificationResult() = 
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val CvvVerificationResult:String = null with get,set
        member val AddressVerificationResult:String = null with get,set
        member val PostalCodeVerificationResult:String = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentCreditCardChargeDetails() = 
        member val CardType:String = null with get,set
        member val ExpMonth:Int32 = new Int32() with get,set
        member val ExpYear:Int32 = new Int32() with get,set
        member val Last4:String = null with get,set
        member val Address:CreditCardBillingAddressItem = null with get,set
        member val VerificationResult:CreditCardChargeVerificationResult = null with get,set

    [<AllowNullLiteral>]
    type AchChargeVerificationResult() = 
        member val NetworkVerificationAttempted:Boolean = new Boolean() with get,set
        member val Result:String = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentAchChargeDetails() = 
        member val AccountType:String = null with get,set
        member val RoutingNumber:String = null with get,set
        member val AccountNumberLast4:String = null with get,set
        member val BankName:String = null with get,set
        member val VerificationResult:AchChargeVerificationResult = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeDetails() = 
        member val PaymentType:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val IntegrationType:String = null with get,set
        member val Currency:String = null with get,set
        member val CardDetails:HeldPaymentCreditCardChargeDetails = null with get,set
        member val AchDetails:HeldPaymentAchChargeDetails = null with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeItem() = 
        member val Type:String = null with get,set
        member val Description:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val ClientInvoiceId:String = null with get,set
        member val ClientInvoiceOwnerTypeId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeRs() = 
        member val TransactionId:String = null with get,set
        member val StoredAccountId:Int64 = new Int64() with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val ChargeType:String = null with get,set
        member val IntegrationType:String = null with get,set
        member val ContextIntegrationPartnerId:Int32 = new Int32() with get,set
        member val CallerIntegrationPartnerId:Int32 = new Int32() with get,set
        member val GatewayResponse:HeldPaymentGatewaySaleResponse = null with get,set
        member val ChargeDetails:HeldPaymentChargeDetails = null with get,set
        member val ChargeItems:ResizeArray<HeldPaymentChargeItem> = new ResizeArray<HeldPaymentChargeItem>() with get,set

    [<AllowNullLiteral>]
    type HeldPaymentChargeRq() = 
        member val integrationType:String = null with get,set
        member val NationalId:Int32 = new Int32() with get,set
        member val ChapterId:Int32 = new Int32() with get,set
        member val StoredAccountId:Int64 = new Int64() with get,set
        member val ContextIntegrationPartnerId:Int32 = new Int32() with get,set
        member val CallerIntegrationPartnerId:Int32 = new Int32() with get,set
        member val AuthenticationId:Int32 = new Int32() with get,set
        member val ChargeType:String = null with get,set
        member val Token:String = null with get,set
        member val Amount:Decimal = new Decimal() with get,set
        member val Description:String = null with get,set
        member val CreatedById:Int32 = new Int32() with get,set
        member val TransactionId:Int64 = new Int64() with get,set
        member val StoreChargeAccount:Boolean = new Boolean() with get,set
        member val ChargeItems:ResizeArray<HeldPaymentChargeItem> = new ResizeArray<HeldPaymentChargeItem>() with get,set
        member val CreatedBy:Int32 = new Int32() with get,set

F# HeldPaymentChargeRq DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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}]}