Finxera

Back to documentation index

updateLinkedPayee

Use updateLinkedPayee to change the details of an already linked payee.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Subscriber Id
+ linkedPayeeId Y Object ID of the linked payee desired.
payeeAccountNumber N String Payee account number (Max Length:45)
memo N String Memo (Max length:128)
+ payee N Object {'ach', 'check', 'paypal'} 'ach' for a non- Finxera bank account,'check' of the mode is check and 'paypal' if the payee has an account with paypal. .

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
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
+ linkedPayeeId   Object ID for the edited linked payee.
payeeAccountNumber   String Payee account number
memo   String Memo
+ payee   Object Payee response contains all the details edited in the request.

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

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="XWSSGID-1261544568770-474929336" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>test.test@test.com</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security></soapenv:Header>
   <soapenv:Body>
      <sch:updateLinkedPayee>
         <updateLinkedPayeeRequest>
            <subscriberId>?</subscriberId>
            <linkedPayeeId>

               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </linkedPayeeId>
            <!--Optional:-->
            <payeeAccountNumber>?</payeeAccountNumber>
            <!--Optional:-->
            <memo>?</memo>
            <payee>
               <!--You have a CHOICE of the next 4 items at this level-->
               <ach>
                  <routingNumber>?</routingNumber>
                  <accountNumber>?</accountNumber>
                  <holderName>?</holderName>
                  <bankAccountType>?</bankAccountType>
               </ach>
               <paypal>
                  <id>?</id>
               </paypal>
               <check>
                  <name>?</name>
                  <address>
                     <line1>?</line1>
                     <!--Optional:-->
                     <line2>?</line2>
                     <city>?</city>
                     <state>?</state>
                     <zipcode>?</zipcode>
                  </address>
               </check>
	       <bancbox>
                  <bancboxPayeeId>?</bancboxPayeeId>
               </bancbox>
            </payee>
         </updateLinkedPayeeRequest>
      </sch:updateLinkedPayee>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateLinkedPayeeResponse xmlns:ns1="schema.bancbox.com">
         <return xsi:type="ns3:updateLinkedPayeeResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <requestId></requestId>
            <status></status>
            <linkedPayeeId>
               <bancBoxId></bancBoxId>

               <subscriberReferenceId></subscriberReferenceId>
            </linkedPayeeId>
            <payeeAccountNumber></payeeAccountNumber>
            <memo></memo>
            <payee>
             <ach>
                  <routingNumber></routingNumber>
                  <accountNumber></accountNumber>
                  <holderName></holderName>
                  <bankAccountType></bankAccountType>
               </ach>

               <check>
                  <name></name>
                  <address>
                     <line1></line1>
                     <city></city>
                     <state></state>
                     <zipcode></zipcode>
                  </address>
               </check>
             <paypal>
                  <id></id>
               </paypal>
             <bancbox>
                  <bancboxPayeeId></bancboxPayeeId>
               </bancbox>
            </payee>
         </return>
      </ns1:updateLinkedPayeeResponse>
   </soap:Body>
</soap:Envelope>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "linkedPayeeId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "payeeAccountNumber": "?",
    "memo": "?",
    "payee": {
        "ach": {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
        },
        "paypal": {
            "id": "?"
        },
        "check": {
            "name": "?",
            "address": {
                "line1": "?",
                "line2": "?",
                "city": "?",
                "state": "?",
                "zipcode": "?"
            }
        },
        "bancbox":
	{ 
	   "bancboxPayeeId":?
	} 
    }
}

Sample Response

{
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }],
    "linkedPayeeId": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "payee": {
        "ach": {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
        },
        "paypal": {
            "id": "?"
        },
        "check": {
            "name": "?",
            "address": {
                "line1": "?",
                "line2": "?",
                "city": "?",
                "state": "?",
                "zipcode": "?"
            }
        },
       "bancbox": {"bancboxPayeeId": 
         }
    }
}