InitiateRefund

Owned by chitra.b (Unlicensed)
Last updated: Mar 24, 2022 by Ross Taylor
1 min read

Usage



Initiates a refund request for processing by Debitsuccess. 

An Order Number and Amount To Refund will be supplied as parameters. The Amount to refund can be any value up to the total amount collected by Debitsuccess to date. There will be a service fee charged for the refund.



Parameters

Name

Data Type

Length



Description

User









  • Username

String



Required

Provided by Debitsuccess

  • Password

String



Required

Provided by Debitsuccess

RequestInitiator

String

100

Optional

Optional – allows requesting user to be logged

AccountReferenceNo

String

15

Optional*

Debitsuccess account reference

ExternalAccountReferenceNo

String

50

Optional*

External account reference

Amount

Decimal (10, 2)



Required

Amount to refund

Description

String

4000

Required

Reason for refund

ExternalRefundIdentifier

String

50

Optional

Unique identifier used in GetRefundStatus to track refund status, must be unique to Account

Allowed characters:

alphanumeric # + - ( ) * _ [space] , ; : . /

* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo

Response 

Name

Data Type

Description

DateCreated

DateTime

Date/time message was processed

Id

String

Unique ID for the message

ResponseNotes ()



Collection of validation messages

  • Code

String



  • Note

String



  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown

ExternalRefundIdentifier

String

Returns either

  • The value provided in initial request

  • A GUID generated by Debitsuccess if no value was provided

RefundRequestNumber

Integer

ID for refund

Error Messages

Type

Error Code

Error Message

 

Error

13012

Invalid Amount value

 

Error

12017

Missing Description

 

Warning

14021

Decimal field '{0}' contains more than 2 decimal points that were ignored by message.

 

Error

12016

Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.

 

Error

08

There is no record found with this criteria

 

Error

07

Multiple accounts found with this criteria

 

Error

13040

Refund amount exceeds amount that has been paid

 

Error

02

Invalid user credentials

 

Error

14143

ExternalRefundIdentifier already exists for a Refund for this Account

 

Error

13203

ExternalRefundIdentifier cannot be more than 50 characters.

 

Error

13204

ExternalRefundIdentifier field contains unallowed characters

 

Info

00

Success

 

Filter by label

There are no items with the selected labels at this time.



On this page:









© 2021 Debitsuccess. All rights reserved