PaySecure Pinless Web Services 2023:07:03:07

AchRefundRequest

The following routes are available for this service:
POST	/ACHRefund


// @DataContract
export class InOutTimes
{

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

// @DataContract
export class RequestTimestamps
{
    // @DataMember(EmitDefaultValue=false)
    public AppLayer: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public RetryLookup: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public GetCardData: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardTokenize: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public CardEncrypt: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBInsert: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public BackendProcess: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public DBUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public ParentUpdate: InOutTimes;

    // @DataMember(EmitDefaultValue=false)
    public Network: InOutTimes;

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

// @DataContract
export class PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public Timestamps: RequestTimestamps;

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

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

export class CardAccountUpdaterDescriptor
{
    public CardDataType: CardInfoType;
    public CardNumberInfo: string;
    public ExpiryDate: string;
    public Status: string;
    public ErrorCode: string;
    public CardToken: string;

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

// @DataContract
export class ExtendedResponse
{
    // @DataMember(EmitDefaultValue=false)
    public CardAccountUpdater: CardAccountUpdaterDescriptor;

    // @DataMember(EmitDefaultValue=false)
    public ProductId: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkResponseCode: string;

    // @DataMember(EmitDefaultValue=false)
    public NetworkTransactionId: string;

    // @DataMember(EmitDefaultValue=false)
    public CHEmailAddrResult: string;

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

// @DataContract
export class PaysecureVersion extends PaysecureResponseInternal
{
    // @DataMember(EmitDefaultValue=false)
    public LocalDateTime: string;

    // @DataMember(EmitDefaultValue=false)
    public Token: string;

    // @DataMember(EmitDefaultValue=false)
    public ExtendedData: ExtendedResponse;

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

// @DataContract
export class Refund extends PaysecureVersion
{
    // @DataMember
    public TranId: string;

    // @DataMember
    public ApprovalCode: string;

    // @DataMember
    public ResponseCode: string;

    // @DataMember
    public Network: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public ErrorCode: string;

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

export class RequestorCredentials
{
    // @Required()
    public MerchantId: string;

    // @Required()
    public UserName: string;

    // @Required()
    public Password: string;

    // @Required()
    public Version: string;

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

export class MerchantDataElements
{
    public RefundSettlementTypeDetails: number;
    public SendRecurringPOSEntryModeFeature: boolean;
    public UseOrgPOSCode: boolean;

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

export class MerchantDescriptorBase
{
    public DataElements: MerchantDataElements;

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

export class MerchantDescriptor extends MerchantDescriptorBase
{
    public Name: string;
    public Address: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public CustomerServiceNumber: string;
    public MCC: string;
    public FNSnum: string;
    public Email: string;

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

export enum TelephoneType
{
    D = 'D',
    H = 'H',
    N = 'N',
    W = 'W',
}

export class Avs
{
    public Address: string;
    public City: string;
    public State: string;
    public Zip: string;
    public Country: string;
    public Email: string;
    public IPAddress: string;
    public TelephoneNumber: string;
    public TelephoneType: TelephoneType;
    public DeliveryMethod: number;
    public FirstName: string;
    public MiddleName: string;
    public LastName: string;

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

// @DataContract
export class ACHExtendedData
{
    // @DataMember
    public CashbackAmount: number;

    // @DataMember
    public ConnectPaySubScriberId: string;

    // @DataMember
    public OrganizationId: string;

    // @DataMember
    public DeviceFingerPrint: string;

    // @DataMember
    public MerchantSessionId: string;

    // @DataMember
    public CurrencyCode: string;

    // @DataMember
    public PaymentType: string;

    // @DataMember
    public VerifyCustomer: boolean;

    // @DataMember
    public CustomerExternalId: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public CustomerName: string;

    // @DataMember
    public AddressLine1: string;

    // @DataMember
    public AddressLine2: string;

    // @DataMember
    public City: string;

    // @DataMember
    public State: string;

    // @DataMember
    public Zip: string;

    // @DataMember
    public Country: string;

    // @DataMember
    public Email: string;

    // @DataMember
    public TelephoneNumber: string;

    // @DataMember
    public ReturnUrl: string;

    // @DataMember
    public CancelUrl: string;

    // @DataMember
    public EstablishData: string;

    // @DataMember
    public RedirectUrl: string;

    // @DataMember
    public RetryAttemptCount: number;

    // @DataMember
    public SignatureHashVersion: string;

    // @DataMember
    public DeadlineHashDate?: string;

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

// @DataContract
export class AchRefundRequest
{
    // @DataMember
    public Credentials: RequestorCredentials;

    // @DataMember
    public TranId: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public ReferenceKey: string;

    // @DataMember
    public MerchantDetails: MerchantDescriptor;

    // @DataMember
    public Custom1: string;

    // @DataMember
    public Custom2: string;

    // @DataMember
    public Custom3: string;

    // @DataMember
    public Custom4: string;

    // @DataMember
    public Custom5: string;

    // @DataMember
    public SignatureHash: string;

    // @DataMember
    public AVS: Avs;

    // @DataMember
    public ExtendedData: ACHExtendedData;

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

TypeScript AchRefundRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Credentials: 
	{
		MerchantId: String,
		UserName: String,
		Password: String,
		Version: String
	},
	TranId: String,
	Amount: 0,
	ReferenceKey: String,
	MerchantDetails: 
	{
		Name: String,
		Address: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		CustomerServiceNumber: String,
		MCC: String,
		FNSnum: String,
		Email: String,
		DataElements: 
		{
			RefundSettlementTypeDetails: 0,
			SendRecurringPOSEntryModeFeature: False,
			UseOrgPOSCode: False
		}
	},
	Custom1: String,
	Custom2: String,
	Custom3: String,
	Custom4: String,
	Custom5: String,
	SignatureHash: String,
	AVS: 
	{
		Address: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Email: String,
		IPAddress: String,
		TelephoneNumber: String,
		TelephoneType: D,
		DeliveryMethod: 0,
		FirstName: String,
		MiddleName: String,
		LastName: String
	},
	ExtendedData: 
	{
		CashbackAmount: 0,
		ConnectPaySubScriberId: String,
		OrganizationId: String,
		DeviceFingerPrint: String,
		MerchantSessionId: String,
		CurrencyCode: String,
		PaymentType: String,
		VerifyCustomer: False,
		CustomerExternalId: String,
		Description: String,
		CustomerName: String,
		AddressLine1: String,
		AddressLine2: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Email: String,
		TelephoneNumber: String,
		ReturnUrl: String,
		CancelUrl: String,
		EstablishData: String,
		RedirectUrl: String,
		RetryAttemptCount: 0,
		SignatureHashVersion: String,
		DeadlineHashDate: 0001-01-01
	}
}

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

{
	TranId: String,
	ApprovalCode: String,
	ResponseCode: String,
	Network: String,
	ErrorMessage: String,
	ErrorCode: String,
	LocalDateTime: String,
	Token: String,
	ExtendedData: 
	{
		CardAccountUpdater: 
		{
			CardDataType: CardNumber,
			CardNumberInfo: String,
			ExpiryDate: String,
			Status: String,
			ErrorCode: String,
			CardToken: String
		},
		ProductId: String,
		NetworkResponseCode: String,
		NetworkTransactionId: String,
		CHEmailAddrResult: String
	},
	Timestamps: 
	{
		AppLayer: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		ParentLookup: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		RetryLookup: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		GetCardData: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		CardTokenize: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		CardEncrypt: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		DBInsert: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		BackendProcess: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		DBUpdate: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		ParentUpdate: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		},
		Network: 
		{
			InTime: 0001-01-01,
			OutTime: 0001-01-01
		}
	}
}