Billhighway Cloud API

<back to all web services

RefundCreditCardPayment

The following routes are available for this service:
POST/api/SalesForce/RefundCreditCardPayment
POST/payments/creditcard/refund

export class RefundCreditCardPaymentReply implements IHaveErrorField
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public ConfirmationNumber?: string;
    public IsError?: boolean;

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

export class RefundCreditCardPayment
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public RefundAmount?: number;
    public Memo?: string;
    public TransactionId?: number;
    public Reason?: string;

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

TypeScript RefundCreditCardPayment DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SalesForce/RefundCreditCardPayment HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RefundCreditCardPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <BhUserId>0</BhUserId>
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <GroupId>String</GroupId>
  <Memo>String</Memo>
  <Reason>String</Reason>
  <RefundAmount>0</RefundAmount>
  <TransactionId>0</TransactionId>
  <UniqueId>String</UniqueId>
  <UserId>String</UserId>
</RefundCreditCardPayment>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RefundCreditCardPaymentReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <ClassName>String</ClassName>
  <ConfirmationNumber>String</ConfirmationNumber>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <UniqueId>String</UniqueId>
</RefundCreditCardPaymentReply>