POST api/Refunds/RegisterMerchantRefundAgreement

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProviderID	integer	None.
SpeedID	integer	None.
PerPayoutMaxAmount	integer	None.
PerPayoutMinAmount	integer	None.
PerFrequencyDays	integer	None.
PerFrequencyMaxAmount	integer	None.
MerchantBSB	string	None.
MerchantAccNo	string	None.
MerchantCode	string	None.
BankName	string	None.
AccountName	string	None.
MerchantEmail	string	None.
AccountProofURL	string	None.
AccountProofFile	string	None.
EndUserAgreementURL	string	None.
UserName	string	None.
MerchantName	string	None.
ActionedUserFullName	string	None.
ActionedUserName	string	None.
ActionedUserDate	string	None.
ActionedUserTitle	string	None.
MerchantABN	string	None.
MerchantContactNumber	string	None.
MerchantWebsite	string	None.
MerchantAddress	string	None.
MerchantFax	string	None.
MerchantContactName	string	None.
IsValidAccount	boolean	None.
DebitableContact	RefundDebitableContact	None.

Request Formats

application/json, text/json

Sample:

{
  "ProviderID": 1,
  "SpeedID": 2,
  "PerPayoutMaxAmount": 3,
  "PerPayoutMinAmount": 4,
  "PerFrequencyDays": 5,
  "PerFrequencyMaxAmount": 6,
  "MerchantBSB": "sample string 7",
  "MerchantAccNo": "sample string 8",
  "MerchantCode": "sample string 9",
  "BankName": "sample string 10",
  "AccountName": "sample string 11",
  "MerchantEmail": "sample string 12",
  "AccountProofURL": "sample string 13",
  "AccountProofFile": "sample string 14",
  "EndUserAgreementURL": "sample string 15",
  "UserName": "sample string 16",
  "MerchantName": "sample string 17",
  "ActionedUserFullName": "sample string 18",
  "ActionedUserName": "sample string 19",
  "ActionedUserDate": "sample string 20",
  "ActionedUserTitle": "sample string 21",
  "MerchantABN": "sample string 22",
  "MerchantContactNumber": "sample string 23",
  "MerchantWebsite": "sample string 24",
  "MerchantAddress": "sample string 25",
  "MerchantFax": "sample string 26",
  "MerchantContactName": "sample string 27",
  "IsValidAccount": true,
  "DebitableContact": {
    "VASKYCDebitableContactsID": "f575f994-e09c-4e7b-acbe-7fa18becb000",
    "VASKYCRefundEntityConfigID": "f4742953-d494-4e28-a1f5-9583f649222c",
    "Ref": "sample string 3",
    "InitiatorID": "a3b5fe61-4c69-4821-b175-064e1f8924bf",
    "AuthoriserID": "dde46d54-0c94-4e4e-aab2-d255a934a93a",
    "ContactID": "67cb1bb5-554d-4555-af03-028c1ee545b4",
    "BankAccountID": "ed008014-2818-4ef0-9d04-7123778f85aa",
    "Status": "sample string 8",
    "Responded_At": "2026-04-07T20:09:28.7098203+10:00",
    "Created_At": "2026-04-07T20:09:28.7098203+10:00",
    "CreatedDateTimeUTC": "2026-04-07T20:09:28.7098203+10:00",
    "ModifiedDateTimeUTC": "2026-04-07T20:09:28.7098203+10:00",
    "IsDeleted": true
  }
}

application/xml, text/xml

Sample:

<RefundsAgreementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Refunds">
  <AccountName>sample string 11</AccountName>
  <AccountProofFile>sample string 14</AccountProofFile>
  <AccountProofURL>sample string 13</AccountProofURL>
  <ActionedUserDate>sample string 20</ActionedUserDate>
  <ActionedUserFullName>sample string 18</ActionedUserFullName>
  <ActionedUserName>sample string 19</ActionedUserName>
  <ActionedUserTitle>sample string 21</ActionedUserTitle>
  <BankName>sample string 10</BankName>
  <DebitableContact>
    <AuthoriserID>dde46d54-0c94-4e4e-aab2-d255a934a93a</AuthoriserID>
    <BankAccountID>ed008014-2818-4ef0-9d04-7123778f85aa</BankAccountID>
    <ContactID>67cb1bb5-554d-4555-af03-028c1ee545b4</ContactID>
    <CreatedDateTimeUTC>2026-04-07T20:09:28.7098203+10:00</CreatedDateTimeUTC>
    <Created_At>2026-04-07T20:09:28.7098203+10:00</Created_At>
    <InitiatorID>a3b5fe61-4c69-4821-b175-064e1f8924bf</InitiatorID>
    <IsDeleted>true</IsDeleted>
    <ModifiedDateTimeUTC>2026-04-07T20:09:28.7098203+10:00</ModifiedDateTimeUTC>
    <Ref>sample string 3</Ref>
    <Responded_At>2026-04-07T20:09:28.7098203+10:00</Responded_At>
    <Status>sample string 8</Status>
    <VASKYCDebitableContactsID>f575f994-e09c-4e7b-acbe-7fa18becb000</VASKYCDebitableContactsID>
    <VASKYCRefundEntityConfigID>f4742953-d494-4e28-a1f5-9583f649222c</VASKYCRefundEntityConfigID>
  </DebitableContact>
  <EndUserAgreementURL>sample string 15</EndUserAgreementURL>
  <IsValidAccount>true</IsValidAccount>
  <MerchantABN>sample string 22</MerchantABN>
  <MerchantAccNo>sample string 8</MerchantAccNo>
  <MerchantAddress>sample string 25</MerchantAddress>
  <MerchantBSB>sample string 7</MerchantBSB>
  <MerchantCode>sample string 9</MerchantCode>
  <MerchantContactName>sample string 27</MerchantContactName>
  <MerchantContactNumber>sample string 23</MerchantContactNumber>
  <MerchantEmail>sample string 12</MerchantEmail>
  <MerchantFax>sample string 26</MerchantFax>
  <MerchantName>sample string 17</MerchantName>
  <MerchantWebsite>sample string 24</MerchantWebsite>
  <PerFrequencyDays>5</PerFrequencyDays>
  <PerFrequencyMaxAmount>6</PerFrequencyMaxAmount>
  <PerPayoutMaxAmount>3</PerPayoutMaxAmount>
  <PerPayoutMinAmount>4</PerPayoutMinAmount>
  <ProviderID>1</ProviderID>
  <SpeedID>2</SpeedID>
  <UserName>sample string 16</UserName>
</RefundsAgreementRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RefundsAgreementRequest'.

Response Information

Resource Description

RefundsCommonResult

Name	Type	Additional information
ErrorMessage	string	None.
FormattedErrorMessage	string	None.
Result	Object	None.
ErrorResult	Collection of string	None.
SuccessfulResult	Collection of string	None.
IsSuccessful	boolean	None.
Signupurl	URI	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 1",
  "FormattedErrorMessage": "sample string 2",
  "Result": {},
  "ErrorResult": [
    "sample string 1",
    "sample string 2"
  ],
  "SuccessfulResult": [
    "sample string 1",
    "sample string 2"
  ],
  "IsSuccessful": true,
  "Signupurl": "http://webapihelppage5.com"
}

application/xml, text/xml

Sample:

<RefundsCommonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <ErrorMessage>sample string 1</ErrorMessage>
  <ErrorResult xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorResult>
  <FormattedErrorMessage>sample string 2</FormattedErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Result />
  <Signupurl>http://webapihelppage5.com/</Signupurl>
  <SuccessfulResult xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SuccessfulResult>
</RefundsCommonResult>