POST api/Refunds/RefundTransaction

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RefundRequestID	globally unique identifier	None.
POLiEntityID	globally unique identifier	None.
POLiServiceID	globally unique identifier	None.
RefundsID	string	None.
POLiID	string	None.
RefundAmount	decimal number	None.
RefundStatusID	integer	None.
ProviderID	integer	None.
SpeedID	integer	None.
SpeedName	string	None.
CustomerName	string	None.
CustomerBSBNo	string	None.
CustomerAccountNo	string	None.
CustomerBankName	string	None.
EntityBSBNo	string	None.
EntityAccountNo	string	None.
RefundInitiatedDate	date	None.
RefundModifiedDate	date	None.
RefundInitiatedBy	globally unique identifier	None.
RefundModifiedBy	globally unique identifier	None.
PaymentRef	string	None.
RefundFailureCodeID	integer	None.
PaymentSource	string	None.
MerchantReference	string	None.
ReasonForRefund	string	None.
ContactId	globally unique identifier	None.
UserId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "RefundRequestID": "b37ee56a-50c1-4550-a0af-6d7495d309e0",
  "POLiEntityID": "f0d6f9b8-1a67-48b1-8de4-34a7f5d66580",
  "POLiServiceID": "ac70dc2e-557a-4632-9d2d-4f0a4fafe42d",
  "RefundsID": "sample string 4",
  "POLiID": "sample string 5",
  "RefundAmount": 6.1,
  "RefundStatusID": 7,
  "ProviderID": 8,
  "SpeedID": 9,
  "SpeedName": "sample string 10",
  "CustomerName": "sample string 11",
  "CustomerBSBNo": "sample string 12",
  "CustomerAccountNo": "sample string 13",
  "CustomerBankName": "sample string 14",
  "EntityBSBNo": "sample string 15",
  "EntityAccountNo": "sample string 16",
  "RefundInitiatedDate": "2026-04-07T20:06:33.4483529+10:00",
  "RefundModifiedDate": "2026-04-07T20:06:33.4483529+10:00",
  "RefundInitiatedBy": "0ce5ec28-ced4-4a1d-b1ac-5d3f5fac8667",
  "RefundModifiedBy": "3e082c44-e661-4e1e-a5cb-730dd74de084",
  "PaymentRef": "sample string 21",
  "RefundFailureCodeID": 22,
  "PaymentSource": "sample string 23",
  "MerchantReference": "sample string 24",
  "ReasonForRefund": "sample string 25",
  "ContactId": "6d2979fd-d659-45fb-ba7c-933aed9d23d2",
  "UserId": "65e64787-763d-43d0-8f2e-6c53246e5502"
}

application/xml, text/xml

Sample:

<RefundsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Refunds">
  <ContactId>6d2979fd-d659-45fb-ba7c-933aed9d23d2</ContactId>
  <CustomerAccountNo>sample string 13</CustomerAccountNo>
  <CustomerBSBNo>sample string 12</CustomerBSBNo>
  <CustomerBankName>sample string 14</CustomerBankName>
  <CustomerName>sample string 11</CustomerName>
  <EntityAccountNo>sample string 16</EntityAccountNo>
  <EntityBSBNo>sample string 15</EntityBSBNo>
  <MerchantReference>sample string 24</MerchantReference>
  <POLiEntityID>f0d6f9b8-1a67-48b1-8de4-34a7f5d66580</POLiEntityID>
  <POLiID>sample string 5</POLiID>
  <POLiServiceID>ac70dc2e-557a-4632-9d2d-4f0a4fafe42d</POLiServiceID>
  <PaymentRef>sample string 21</PaymentRef>
  <PaymentSource>sample string 23</PaymentSource>
  <ProviderID>8</ProviderID>
  <ReasonForRefund>sample string 25</ReasonForRefund>
  <RefundAmount>6.1</RefundAmount>
  <RefundFailureCodeID>22</RefundFailureCodeID>
  <RefundInitiatedBy>0ce5ec28-ced4-4a1d-b1ac-5d3f5fac8667</RefundInitiatedBy>
  <RefundInitiatedDate>2026-04-07T20:06:33.4483529+10:00</RefundInitiatedDate>
  <RefundModifiedBy>3e082c44-e661-4e1e-a5cb-730dd74de084</RefundModifiedBy>
  <RefundModifiedDate>2026-04-07T20:06:33.4483529+10:00</RefundModifiedDate>
  <RefundRequestID>b37ee56a-50c1-4550-a0af-6d7495d309e0</RefundRequestID>
  <RefundStatusID>7</RefundStatusID>
  <RefundsID>sample string 4</RefundsID>
  <SpeedID>9</SpeedID>
  <SpeedName>sample string 10</SpeedName>
  <UserId>65e64787-763d-43d0-8f2e-6c53246e5502</UserId>
</RefundsRequest>

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 'RefundsRequest'.

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>