| POST | /integrations/api/{integrationType}/core/charge |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.DTO.CoreCharges.Api.Request;
using BH.CloudAPI.DTO;
using BH.CloudAPI.DTO.CoreCharges.Api.Response;
using BH.CloudAPI.DTO.CoreCharges;
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
{
public partial class ReferenceIdTypedAssociationItem
{
public virtual string Value { get; set; }
public virtual string Type { get; set; }
}
}
namespace BH.CloudAPI.DTO.Charges.Api
{
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.CoreCharges
{
public partial class CoreChargeDetails
{
public virtual string PaymentType { get; set; }
public virtual int Amount { get; set; }
public virtual string IntegrationType { get; set; }
public virtual string Currency { get; set; }
public virtual CoreCreditCardChargeDetails CardDetails { get; set; }
}
public partial class CoreChargeGatewaySaleResponse
{
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; }
}
public partial class CoreCreditCardChargeDetails
{
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.CoreCharges.Api.Request
{
public partial class CoreChargeRq
: IChargeRequest
{
public CoreChargeRq()
{
Invoices = new Dictionary<long, decimal>{};
ReferenceIds = new List<ReferenceIdTypedAssociationItem>{};
}
[ApiMember(ParameterType="path")]
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 UserId { get; set; }
public virtual int AuthenticationId { get; set; }
public virtual string ChargeType { get; set; }
public virtual string Token { get; set; }
[ApiMember(Format="decimal", ParameterType="model")]
public virtual decimal Amount { get; set; }
public virtual string Description { get; set; }
public virtual Dictionary<long, decimal> Invoices { get; set; }
public virtual int CreatedById { get; set; }
public virtual List<ReferenceIdTypedAssociationItem> ReferenceIds { get; set; }
public virtual long TransactionId { get; set; }
}
}
namespace BH.CloudAPI.DTO.CoreCharges.Api.Response
{
public partial class CoreChargeRs
{
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 CoreChargeGatewaySaleResponse GatewayResponse { get; set; }
public virtual CoreChargeDetails ChargeDetails { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /integrations/api/{integrationType}/core/charge HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
integrationType: String,
NationalId: 0,
ChapterId: 0,
StoredAccountId: 0,
ContextIntegrationPartnerId: 0,
CallerIntegrationPartnerId: 0,
UserId: 0,
AuthenticationId: 0,
ChargeType: String,
Token: String,
Amount: 0,
Description: String,
Invoices:
{
0: 0
},
CreatedById: 0,
ReferenceIds:
[
{
Value: String,
Type: String
}
],
TransactionId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}
}