Finxera

Back to documentation index

collectFees

If your service or application requiries transactional or service fees from your users, you can schedule fee collection directly against your client's Finxera account using the collectFees method. Any fees collected will be sent to your subscriber fee and revenue account (F&R Account) determined when you first subscribe to Finxera.

Request Parameters

  Parameter Required Type Description
subscriberId Y long Specify subscriber ID issued when Finxera account is created
+ account Y Object If a list of transactions for a single account is desired, then specify either the account Id(Finxera generated Account Number or the subscriber defined account number) or the subscriberReference ID for the account.
+ items Y Object Specify details about the fee, repeat to schedule more than one fee.

Response Parameters

  Parameter   Type Description
requestId   long 13 digit ID for the API request being made.
status   int Status of completed request, either 1 for pass, or 0 for fail
+ itemStatuses   Object Item Statuses

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

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
 <soapenv:Header/>
   <soapenv:Body>
      <sch:collectFees>
         <collectFeesRequest>
            <subscriberId>?</subscriberId>
            <account>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </account>
            <!--1 or more repetitions:-->
            <items>
               <!--Optional:-->
               <referenceId>?</referenceId>
               <amount>?</amount>
               <!--Optional:-->
               <memo>?</memo>
               <!--Optional:-->
               <scheduled>
                  <scheduleDate>?</scheduleDate>
               </scheduled>
            </items>
         </collectFeesRequest>
      </sch:collectFees>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<requestId></requestId> 
<status></status> 
<itemStatuses> 
	<id> 
		<bancBoxId></bancBoxId> 
		<subscriberReferenceId></subscriberReferenceId> 
	</id> 
	<status></status> 
	<messageCode></messageCode> 
	<messageDesc></messageDesc> 
	<itemStatus></itemStatus> 
	<code></code> 
	<message></message>

</itemStatuses> 

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "account" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "items": [{
        "referenceId": "?",
        "amount": ? ,
        "memo" : "?",
        "scheduleDate": "?"
    }]
}

Sample Response

{
    "itemStatuses": [{
        "id": {
            "bancBoxId": ? ,
            "subscriberReferenceId" : "?",
        },
        "status": "?",
        "messageCode": "?",
        "messageDesc": "?",
        "code": "?",
        "message": "?",
        "itemStatus": ?
    }],
    "requestId": ? ,
    "status" : ?
}

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