PaySecure Pinless Web Services 2023:07:03:07

<back to all web services

AchRefundRequest

The following routes are available for this service:
POST/ACHRefund
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Paysecure.ServiceModel;
using Paysecure.ServiceModel.Types;

namespace Paysecure.ServiceModel
{
    [DataContract]
    public partial class AchRefundRequest
    {
        [DataMember]
        public virtual RequestorCredentials Credentials { get; set; }

        [DataMember]
        public virtual string TranId { get; set; }

        [DataMember]
        public virtual int Amount { get; set; }

        [DataMember]
        public virtual string ReferenceKey { get; set; }

        [DataMember]
        public virtual MerchantDescriptor MerchantDetails { get; set; }

        [DataMember]
        public virtual string Custom1 { get; set; }

        [DataMember]
        public virtual string Custom2 { get; set; }

        [DataMember]
        public virtual string Custom3 { get; set; }

        [DataMember]
        public virtual string Custom4 { get; set; }

        [DataMember]
        public virtual string Custom5 { get; set; }

        [DataMember]
        public virtual string SignatureHash { get; set; }

        [DataMember]
        public virtual Avs AVS { get; set; }

        [DataMember]
        public virtual ACHExtendedData ExtendedData { get; set; }
    }

    public partial class Avs
    {
        public virtual string Address { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Country { get; set; }
        public virtual string Email { get; set; }
        public virtual string IPAddress { get; set; }
        public virtual string TelephoneNumber { get; set; }
        public virtual TelephoneType TelephoneType { get; set; }
        public virtual int DeliveryMethod { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string LastName { get; set; }
    }

    public partial class MerchantDescriptor
        : MerchantDescriptorBase
    {
        public virtual string Name { get; set; }
        public virtual string Address { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Country { get; set; }
        public virtual string CustomerServiceNumber { get; set; }
        public virtual string MCC { get; set; }
        public virtual string FNSnum { get; set; }
        public virtual string Email { get; set; }
    }

    public partial class MerchantDescriptorBase
    {
        public virtual MerchantDataElements DataElements { get; set; }
    }

    [DataContract]
    public partial class Refund
        : PaysecureVersion
    {
        [DataMember]
        public virtual string TranId { get; set; }

        [DataMember]
        public virtual string ApprovalCode { get; set; }

        [DataMember]
        public virtual string ResponseCode { get; set; }

        [DataMember]
        public virtual string Network { get; set; }

        [DataMember]
        public virtual string ErrorMessage { get; set; }

        [DataMember]
        public virtual string ErrorCode { get; set; }
    }

    public enum TelephoneType
    {
        D,
        H,
        N,
        W,
    }

}

namespace Paysecure.ServiceModel.Types
{
    [DataContract]
    public partial class ACHExtendedData
    {
        [DataMember]
        public virtual int CashbackAmount { get; set; }

        [DataMember]
        public virtual string ConnectPaySubScriberId { get; set; }

        [DataMember]
        public virtual string OrganizationId { get; set; }

        [DataMember]
        public virtual string DeviceFingerPrint { get; set; }

        [DataMember]
        public virtual string MerchantSessionId { get; set; }

        [DataMember]
        public virtual string CurrencyCode { get; set; }

        [DataMember]
        public virtual string PaymentType { get; set; }

        [DataMember]
        public virtual bool VerifyCustomer { get; set; }

        [DataMember]
        public virtual string CustomerExternalId { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string CustomerName { get; set; }

        [DataMember]
        public virtual string AddressLine1 { get; set; }

        [DataMember]
        public virtual string AddressLine2 { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string State { get; set; }

        [DataMember]
        public virtual string Zip { get; set; }

        [DataMember]
        public virtual string Country { get; set; }

        [DataMember]
        public virtual string Email { get; set; }

        [DataMember]
        public virtual string TelephoneNumber { get; set; }

        [DataMember]
        public virtual string ReturnUrl { get; set; }

        [DataMember]
        public virtual string CancelUrl { get; set; }

        [DataMember]
        public virtual string EstablishData { get; set; }

        [DataMember]
        public virtual string RedirectUrl { get; set; }

        [DataMember]
        public virtual int RetryAttemptCount { get; set; }

        [DataMember]
        public virtual string SignatureHashVersion { get; set; }

        [DataMember]
        public virtual DateTime? DeadlineHashDate { get; set; }
    }

    public partial class CardAccountUpdaterDescriptor
    {
        public virtual CardInfoType CardDataType { get; set; }
        public virtual string CardNumberInfo { get; set; }
        public virtual string ExpiryDate { get; set; }
        public virtual string Status { get; set; }
        public virtual string ErrorCode { get; set; }
        public virtual string CardToken { get; set; }
    }

    public enum CardInfoType
    {
        CardNumber,
        Token,
        Track,
        EMV,
        Encrypted,
        DPAN,
        ApplePay,
        GooglePay,
        SamsungPay,
        CPToken,
        EncryptedEnhanced,
        EncryptedJWE,
    }

    [DataContract]
    public partial class ExtendedResponse
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual CardAccountUpdaterDescriptor CardAccountUpdater { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string ProductId { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string NetworkResponseCode { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string NetworkTransactionId { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string CHEmailAddrResult { get; set; }
    }

    [DataContract]
    public partial class InOutTimes
    {
    }

    public partial class MerchantDataElements
    {
        public virtual int RefundSettlementTypeDetails { get; set; }
        public virtual bool SendRecurringPOSEntryModeFeature { get; set; }
        public virtual bool UseOrgPOSCode { get; set; }
    }

    [DataContract]
    public partial class PaysecureResponseInternal
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual RequestTimestamps Timestamps { get; set; }
    }

    [DataContract]
    public partial class PaysecureVersion
        : PaysecureResponseInternal
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual string LocalDateTime { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual string Token { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual ExtendedResponse ExtendedData { get; set; }
    }

    public partial class RequestorCredentials
    {
        [Required]
        public virtual string MerchantId { get; set; }

        [Required]
        public virtual string UserName { get; set; }

        [Required]
        public virtual string Password { get; set; }

        [Required]
        public virtual string Version { get; set; }
    }

    [DataContract]
    public partial class RequestTimestamps
    {
        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes AppLayer { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes ParentLookup { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes RetryLookup { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes GetCardData { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes CardTokenize { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes CardEncrypt { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes DBInsert { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes BackendProcess { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes DBUpdate { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes ParentUpdate { get; set; }

        [DataMember(EmitDefaultValue=false)]
        public virtual InOutTimes Network { get; set; }
    }

}

C# AchRefundRequest 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 /ACHRefund HTTP/1.1 
Host: api.paysecure.acculynk.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AchRefundRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <AVS>
    <Address>String</Address>
    <City>String</City>
    <Country>String</Country>
    <DeliveryMethod>0</DeliveryMethod>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <IPAddress>String</IPAddress>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <State>String</State>
    <TelephoneNumber>String</TelephoneNumber>
    <TelephoneType>D</TelephoneType>
    <Zip>String</Zip>
  </AVS>
  <Amount>0</Amount>
  <Credentials>
    <MerchantId>String</MerchantId>
    <Password>String</Password>
    <UserName>String</UserName>
    <Version>String</Version>
  </Credentials>
  <Custom1>String</Custom1>
  <Custom2>String</Custom2>
  <Custom3>String</Custom3>
  <Custom4>String</Custom4>
  <Custom5>String</Custom5>
  <ExtendedData>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <CancelUrl>String</CancelUrl>
    <CashbackAmount>0</CashbackAmount>
    <City>String</City>
    <ConnectPaySubScriberId>String</ConnectPaySubScriberId>
    <Country>String</Country>
    <CurrencyCode>String</CurrencyCode>
    <CustomerExternalId>String</CustomerExternalId>
    <CustomerName>String</CustomerName>
    <DeadlineHashDate>0001-01-01T00:00:00</DeadlineHashDate>
    <Description>String</Description>
    <DeviceFingerPrint>String</DeviceFingerPrint>
    <Email>String</Email>
    <EstablishData>String</EstablishData>
    <MerchantSessionId>String</MerchantSessionId>
    <OrganizationId>String</OrganizationId>
    <PaymentType>String</PaymentType>
    <RedirectUrl>String</RedirectUrl>
    <RetryAttemptCount>0</RetryAttemptCount>
    <ReturnUrl>String</ReturnUrl>
    <SignatureHashVersion>String</SignatureHashVersion>
    <State>String</State>
    <TelephoneNumber>String</TelephoneNumber>
    <VerifyCustomer>false</VerifyCustomer>
    <Zip>String</Zip>
  </ExtendedData>
  <MerchantDetails>
    <DataElements>
      <RefundSettlementTypeDetails>0</RefundSettlementTypeDetails>
      <SendRecurringPOSEntryModeFeature>false</SendRecurringPOSEntryModeFeature>
      <UseOrgPOSCode>false</UseOrgPOSCode>
    </DataElements>
    <Address>String</Address>
    <City>String</City>
    <Country>String</Country>
    <CustomerServiceNumber>String</CustomerServiceNumber>
    <Email>String</Email>
    <FNSnum>String</FNSnum>
    <MCC>String</MCC>
    <Name>String</Name>
    <State>String</State>
    <Zip>String</Zip>
  </MerchantDetails>
  <ReferenceKey>String</ReferenceKey>
  <SignatureHash>String</SignatureHash>
  <TranId>String</TranId>
</AchRefundRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Refund xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Timestamps>
    <AppLayer>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </AppLayer>
    <BackendProcess>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </BackendProcess>
    <CardEncrypt>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </CardEncrypt>
    <CardTokenize>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </CardTokenize>
    <DBInsert>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </DBInsert>
    <DBUpdate>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </DBUpdate>
    <GetCardData>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </GetCardData>
    <Network>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </Network>
    <ParentLookup>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </ParentLookup>
    <ParentUpdate>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </ParentUpdate>
    <RetryLookup>
      <InTime>0001-01-01T00:00:00</InTime>
      <OutTime>0001-01-01T00:00:00</OutTime>
    </RetryLookup>
  </Timestamps>
  <ExtendedData>
    <CHEmailAddrResult>String</CHEmailAddrResult>
    <CardAccountUpdater>
      <CardDataType>CardNumber</CardDataType>
      <CardNumberInfo>String</CardNumberInfo>
      <CardToken>String</CardToken>
      <ErrorCode>String</ErrorCode>
      <ExpiryDate>String</ExpiryDate>
      <Status>String</Status>
    </CardAccountUpdater>
    <NetworkResponseCode>String</NetworkResponseCode>
    <NetworkTransactionId>String</NetworkTransactionId>
    <ProductId>String</ProductId>
  </ExtendedData>
  <LocalDateTime>String</LocalDateTime>
  <Token>String</Token>
  <ApprovalCode>String</ApprovalCode>
  <ErrorCode>String</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <Network>String</Network>
  <ResponseCode>String</ResponseCode>
  <TranId>String</TranId>
</Refund>