Billhighway Cloud API

<back to all web services

HeldPaymentChargeRefundRq

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 HeldPaymentChargeRefundRs
{
    public NationalId?: number;
    public ChapterId?: number;
    public IntegrationType?: string;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public GatewayResponse?: HeldPaymentGatewaySaleResponse;
    public ChargeDetails?: HeldPaymentChargeDetails;

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

export class HeldPaymentCreditCardChargeRefundDetails
{
    public CardRef?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public CVV?: string;
    public CardType?: string;
    public NameOnCard?: string;
    public Address1?: string;
    public Address2?: string;
    public City?: string;
    public State?: string;
    public PostalCode?: string;
    public Country?: string;

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

export class HeldPaymentChargeRefundRq
{
    public integrationType?: string;
    public NationalId?: number;
    public ChapterId?: number;
    public UserId?: number;
    public ContextIntegrationPartnerId?: number;
    public CallerIntegrationPartnerId?: number;
    public AuthenticationId?: number;
    public Amount?: number;
    public Description?: string;
    public GatewayConfirmation?: string;
    public CardInfo?: HeldPaymentCreditCardChargeRefundDetails;

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

TypeScript HeldPaymentChargeRefundRq DTOs

POST /integrations/api/{integrationType}/heldpayment/chargerefund HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	integrationType: String,
	NationalId: 0,
	ChapterId: 0,
	UserId: 0,
	ContextIntegrationPartnerId: 0,
	CallerIntegrationPartnerId: 0,
	AuthenticationId: 0,
	Amount: 0,
	Description: String,
	GatewayConfirmation: String,
	CardInfo: 
	{
		CardRef: String,
		ExpMonth: 0,
		ExpYear: 0,
		CVV: String,
		CardType: String,
		NameOnCard: String,
		Address1: String,
		Address2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NationalId: 0,
	ChapterId: 0,
	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
			}
		}
	}
}