| POST | /integrations/api/v2/{tokenType}/charge/token |
|---|
export class ChargeTokenOptions
{
public Usages?: number;
public Duration?: number;
public constructor(init?: Partial<ChargeTokenOptions>) { (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 CreditCardChargeItem
{
public NameOnCard?: string;
public ExpMonth?: number;
public ExpYear?: number;
public CardNumber?: string;
public Cvv?: string;
public Address?: CreditCardBillingAddressItem;
public constructor(init?: Partial<CreditCardChargeItem>) { (Object as any).assign(this, init); }
}
export class AchChargeItem
{
public AccountNumber?: string;
public RoutingNumber?: string;
public AccountType?: string;
public AccountHolderName?: string;
public constructor(init?: Partial<AchChargeItem>) { (Object as any).assign(this, init); }
}
export class ReferenceIdTypedAssociationItem
{
public Value?: string;
public Type?: string;
public constructor(init?: Partial<ReferenceIdTypedAssociationItem>) { (Object as any).assign(this, init); }
}
export class ChargeTokenRqBase implements IChapterAuthorizationRequest, IApiResultErrorService
{
public tokenType?: string;
public Amount?: number;
public Description?: string;
public Options?: ChargeTokenOptions;
public CardInfo?: CreditCardChargeItem;
public AchInfo?: AchChargeItem;
public ReferenceIds?: ReferenceIdTypedAssociationItem[];
public constructor(init?: Partial<ChargeTokenRqBase>) { (Object as any).assign(this, init); }
}
export class CreditCardChargeDetailsV2
{
public CardType?: string;
public ExpMonth?: number;
public ExpYear?: number;
public Last4?: string;
public Address?: CreditCardBillingAddressItem;
public constructor(init?: Partial<CreditCardChargeDetailsV2>) { (Object as any).assign(this, init); }
}
export class AchChargeDetailsV2
{
public AccountType?: string;
public RoutingNumber?: string;
public AccountNumberLast4?: string;
public BankName?: string;
public constructor(init?: Partial<AchChargeDetailsV2>) { (Object as any).assign(this, init); }
}
export class ChargeTokenV2Rs
{
public Token?: string;
public Amount?: number;
public TokenType?: string;
public Description?: string;
public ExpiresOn?: string;
public Currency?: string;
public Usages?: number;
public CardDetails?: CreditCardChargeDetailsV2;
public AchDetails?: AchChargeDetailsV2;
public constructor(init?: Partial<ChargeTokenV2Rs>) { (Object as any).assign(this, init); }
}
export class ChargeTokenV2Rq extends ChargeTokenRqBase
{
public constructor(init?: Partial<ChargeTokenV2Rq>) { super(init); (Object as any).assign(this, init); }
}
TypeScript ChargeTokenV2Rq DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /integrations/api/v2/{tokenType}/charge/token HTTP/1.1
Host: devapi.billhighway.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"tokenType":"String","Amount":0,"Description":"String","Options":{"Usages":0,"Duration":0},"CardInfo":{"NameOnCard":"String","ExpMonth":0,"ExpYear":0,"CardNumber":"String","Cvv":"String","Address":{"Address1":"String","Address2":"String","City":"String","PostalCode":"String","Region":"String","Country":"String","Attributes":[{"Name":"String","Value":"String"}]}},"AchInfo":{"AccountNumber":"String","RoutingNumber":"String","AccountType":"String","AccountHolderName":"String"},"ReferenceIds":[{"Value":"String","Type":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Token":"String","Amount":0,"TokenType":"String","Description":"String","ExpiresOn":"0001-01-01T00:00:00.0000000","Currency":"String","Usages":0,"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"}]}},"AchDetails":{"AccountType":"String","RoutingNumber":"String","AccountNumberLast4":"String","BankName":"String"}}