Finxera

Back to documentation index

returnFunds

Use the returnFund API to return the funds for a transaction. The returnFund API issues a refund amount against a transaction. You can either refund the full amount of the transaction or you can issue a partial refund, where the amount is less than the transaction amount.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ scheduleId N Object Specify the schedule ID parameter to create a list of information on a specific schedule. Define either bancBoxId or subscriberReferenceId.
reasonForRefund N String Enter the reason for refund (Max length:128)

Response Parameters

  Parameter   Type Description
requestId   Long 13 digit ID for the API request being made
status   Int It is the Status of completed request, (1 for pass or 0 for fail)
+ warnings   Object Warning
+ errors   Object Error

WSDL URL (Production) :  https://api.bancbox.com/v3/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPort?wsdl

Sample Request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:returnFund>
         <returnFund>
            <subscriberId>?</subscriberId>
            <scheduleId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </scheduleId>
            <!--Optional:-->
            <reasonForRefund>?</reasonForRefund>
         </returnFund>
      </sch:returnFund>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:returnFundResponse>
         <return>
            <!--Optional:-->
            <requestId>?</requestId>
            <status>?</status>
            <!--Zero or more repetitions:-->
            <warnings>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </warnings>
            <!--Zero or more repetitions:-->
            <errors>
               <!--Optional:-->
               <code>?</code>
               <!--Optional:-->
               <message>?</message>
            </errors>
         </return>
      </sch:returnFundResponse>
   </soapenv:Body>
</soapenv:Envelope>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v3/BBXPortRest/returnFunds
URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPortRest/returnFunds

Sample Request

{
 "authentication":
 {
  "apiKey":"",
  "secret":""
 }, 
    "subscriberId":,
    "scheduleId":{
    		"bancBoxId":
    },
    "reasonForRefund":""
}

Sample Response

{
   "requestId":,
   "status": ,
   "warnings": null
"errors": null
}

Note: This is a beta version. The api listed here are likely to change.