Finxera

Back to documentation index

updateLinkedExternalAccount

Use update linked external account API to change the details of a previously made linked external account.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long ID issued by bancBox when subscriber signs up.
+ linkedExternalAccountId Y Object ID of the external account.
+ account Y Object Specify one of the following accounts { 'paypalAccount', 'cardAccount', 'bankAccount'}

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.
+ error   Object Request failed, error response.
+ linkedExternalAccountId   Object The ID of the external account being updated.
+ account   Object Describes the newly updated external account.

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:updateLinkedExternalAccount>
         <updateLinkedExternalAccountRequest>
            <subscriberId>?</subscriberId>      
            <linkedExternalAccountId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </linkedExternalAccountId>
            <account>
               <!--You have a CHOICE of the next 3 items at this level-->
               <bankAccount>
                  <!--Optional:-->
                  <routingNumber>?</routingNumber>
                  <!--Optional:-->
                  <accountNumber>?</accountNumber>
                  <!--Optional:-->
                  <holderName>?</holderName>
                  <!--Optional:-->
                  <bankAccountType>?</bankAccountType>
               </bankAccount>
               <cardAccount>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <creditCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <expiryDate>?</expiryDate>
                     <!--Optional:-->
                     <type>?</type>
                     <!--Optional:-->
                     <name>?</name>
                     <!--Optional:-->
                     <cvv>?</cvv>
                     <!--Optional:-->
                     <address>
                        <!--Optional:-->
                        <line1>?</line1>
                        <!--Optional:-->
                        <line2>?</line2>
                        <!--Optional:-->
                        <city>?</city>
                        <!--Optional:-->
                        <state>?</state>
                        <!--Optional:-->
                        <zipcode>?</zipcode>
                     </address>
                  </creditCardAccount>
                  <debitCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <type>?</type>
                     <!--Optional:-->
                     <pin>?</pin>
                  </debitCardAccount>
                  <giftCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <pin>?</pin>
                  </giftCardAccount>
               </cardAccount>
               <paypalAccount>
                  <id>?</id>
               </paypalAccount>
            </account>
         </updateLinkedExternalAccountRequest>
      </sch:updateLinkedExternalAccount>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateLinkedExternalAccountResponse xmlns:ns1="schema.bancbox.com">
         <return xsi:type="ns3:updateLinkedExternalAccountResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <requestId>?</requestId>
            <status>?</status>
            <linkedExternalAccountId>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </linkedExternalAccountId>
            
            <account>
               <!--You have a CHOICE of the next 3 items at this level-->
               <bankAccount>
                  <!--Optional:-->
                  <routingNumber>?</routingNumber>
                  <!--Optional:-->
                  <accountNumber>?</accountNumber>
                  <!--Optional:-->
                  <holderName>?</holderName>
                  <!--Optional:-->
                  <bankAccountType>?</bankAccountType>
               </bankAccount>
               <cardAccount>
                  <!--You have a CHOICE of the next 3 items at this level-->
                  <creditCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <expiryDate>?</expiryDate>
                     <!--Optional:-->
                     <type>?</type>
                     <!--Optional:-->
                     <name>?</name>
                     <!--Optional:-->
                     <cvv>?</cvv>
                     <!--Optional:-->
                     <address>
                        <!--Optional:-->
                        <line1>?</line1>
                        <!--Optional:-->
                        <line2>?</line2>
                        <!--Optional:-->
                        <city>?</city>
                        <!--Optional:-->
                        <state>?</state>
                        <!--Optional:-->
                        <zipcode>?</zipcode>
                     </address>
                  </creditCardAccount>
                  <debitCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <type>?</type>
                     <!--Optional:-->
                     <pin>?</pin>
                  </debitCardAccount>
                  <giftCardAccount>
                     <!--Optional:-->
                     <number>?</number>
                     <!--Optional:-->
                     <pin>?</pin>
                  </giftCardAccount>
               </cardAccount>
               <paypalAccount>
                  <id>?</id>
               </paypalAccount>
            </account>
         </return>
      </ns1:updateLinkedExternalAccountResponse>
   </soap:Body>
</soap:Envelope>

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

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": ? ,
    "linkedExternalAccountId" : {
        "bancBoxId": ? ,
        "subscriberReferenceId" : "?"
    },
    "account": {
        "bankAccount": {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
        },
        "cardAccount": {
            "creditCardAccount": {
                "number": "?",
                "expiryDate": "?",
                "type": "?",
                "name": "?",
                "cvv": "?",
                "address": {
                    "line1": "?",
                    "city": "?",
                    "state": "?",
                    "zipcode": "?"
                }
            },
            "debitCardAccount": {
                "number": "?",
                "type": "?",
                "pin": "?"
            },
            "giftCardAccount": {
                "number": "?",
                "pin": "?"
            }
        },
        "paypalAccount": {
            "id": "?"
        }
    }
}

Sample Response

{
    "requestId": ?,
    "status": ?,
    "warnings": [
        {
            "code": "?",
            "message": "?"
        }
    ],
    "errors": [
        {
            "code": "?",
            "message": "?"
        }
    ],
    "linkedExternalAccountId": {
        "bancBoxId": ?,
        "subscriberReferenceId": "?"
    },
    "account": {
        "bankAccount": {
            "routingNumber": "?",
            "accountNumber": "?",
            "holderName": "?",
            "bankAccountType": "?"
        },
        "cardAccount": {
            "creditCardAccount": {
                "number": "?",
                "expiryDate": "?",
                "type": "?",
                "name": "?",
                "cvv": "?",
                "address": {
                    "line1": "?",
                    "city": "?",
                    "state": "?",
                    "zipcode": "?"
                }
            },
            "debitCardAccount": {
                "number": "?",
                "type": "?",
                "pin": "?"
            },
            "giftCardAccount": {
                "number": "?",
                "pin": "?"
            }
        },
        "paypalAccount": {
            "id": "?"
        }
    }
}