Billhighway Cloud API

<back to all web services

HeldPaymentChargeRq

export class HeldPaymentGatewaySaleResponse
{
    public FailureType?: string;
    public IsDuplicate?: boolean;
    public IsSuccessful?: boolean;
    public ErrorCode?: string;
    public Message?: string;
    public GatewayId?: number;
    public ConfirmationNumber?: string;
    public NetworkTransactionId?: string;

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

export class AttributeItem
{
    public Name?: string;
    public Value?: string;

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

export class CreditCardBillingAddressItem
{
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public PostalCode?: string;
    public Region?: string;
    public Country?: string;
    public Attributes?: AttributeItem[];

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

export class CreditCardChargeVerificationResult
{
    public NetworkVerificationAttempted?: boolean;
    public CvvVerificationResult?: string;
    public AddressVerificationResult?: string;
    public PostalCodeVerificationResult?: string;

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

export class HeldPaymentCreditCardChargeDetails
{
    public CardType?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public Last4?: string;
    public Address?: CreditCardBillingAddressItem;
    public VerificationResult?: CreditCardChargeVerificationResult;

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

export class AchChargeVerificationResult
{
    public NetworkVerificationAttempted?: boolean;
    public Result?: string;

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

export class HeldPaymentAchChargeDetails
{
    public AccountType?: string;
    public RoutingNumber?: string;
    public AccountNumberLast4?: string;
    public BankName?: string;
    public VerificationResult?: AchChargeVerificationResult;

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

export class HeldPaymentChargeDetails
{
    public PaymentType?: string;
    public Amount?: number;
    public IntegrationType?: string;
    public Currency?: string;
    public CardDetails?: HeldPaymentCreditCardChargeDetails;
    public AchDetails?: HeldPaymentAchChargeDetails;

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

export class HeldPaymentChargeItem
{
    public Type?: string;
    public Description?: string;
    public Amount?: number;
    public ClientInvoiceId?: string;
    public ClientInvoiceOwnerTypeId?: number;

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

export class HeldPaymentChargeRs
{
    public TransactionId?: string;
    public StoredAccountId?: number;
    public NationalId?: number;
    public ChapterId?: number;
    public ChargeType?: string;
    public IntegrationType?: string;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public GatewayResponse?: HeldPaymentGatewaySaleResponse;
    public ChargeDetails?: HeldPaymentChargeDetails;
    public ChargeItems?: HeldPaymentChargeItem[];

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

export class HeldPaymentChargeRq implements IChargeRequest
{
    public integrationType?: string;
    public NationalId?: number;
    public ChapterId?: number;
    public StoredAccountId?: number;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public AuthenticationId?: number;
    public ChargeType?: string;
    public Token?: string;
    public Amount?: number;
    public Description?: string;
    public CreatedById?: number;
    public TransactionId?: number;
    public StoreChargeAccount?: boolean;
    public ChargeItems?: HeldPaymentChargeItem[];
    public CreatedBy?: number;

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

TypeScript HeldPaymentChargeRq DTOs

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}]}