Finxera

Back to documentation index

linkExternalAccount

Use the linkExternalAccount API to link an external bank, card, or paypal account to a client.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Specify either the bancBoxId or subscriberReferenceId parameter.
referenceId N String ID created by the subscriber for the newly linked external account (Max length:45)
+ account Y Object Link a paypalAccount, creditcardAccount, or a bankAccount. Choose one of these three.

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.
+ Id   Object Newly created IDs for the linked external account, both the bancbox ID and the reference ID

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>sample@email.com</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">sample</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <sch:linkExternalAccount>
            <sch:linkExternalAccount>
                <linkExternalAccountRequest>
                    <subscriberId>?</subscriberId>
                    <clientId>
                        <!--Optional:-->
                        <bancBoxId>?</bancBoxId>
                        <!--Optional:-->
                        <subscriberReferenceId>?</subscriberReferenceId>
                    </clientId>
                    <!--Optional:-->
                    <referenceId>?</referenceId>
                    <account>
                        <!--You have a CHOICE of the next 3 items at this level-->
                        <bankAccount>
                            <routingNumber>?</routingNumber>
                            <accountNumber>?</accountNumber>
                            <holderName>?</holderName>
                            <bankAccountType>?</bankAccountType>
                        </bankAccount>
                        <cardAccount>
                        <!--You have a CHOICE of the next 3 items at this level-->
                        <creditCardAccount>
                         <!--You have a CHOICE of the next 2 items at this level-->
                         <tokenizedId>?</tokenizedId>
                         <creditCardDetails>
                            <number>?</number>
                            <expiryDate>?</expiryDate>
                            <type>?</type>
                            <name>?</name>
                            <cvv>?</cvv>
                            <address>
                               <line1>?</line1>
                               <!--Optional:-->
                               <line2>?</line2>
                               <city>?</city>
                               <state>?</state>
                               <zipcode>?</zipcode>
                            </address>
                         </creditCardDetails>
                  </creditCardAccount>
                            <debitCardAccount>
                                <number>?</number>
                                <type>?</type>
                                <pin>?</pin>
                            </debitCardAccount>
                            <giftCardAccount>
                                <number>?</number>
                                <pin>?</pin>
                            </giftCardAccount>
                        </cardAccount>
                        <paypalAccount>
                            <id>?</id>
                        </paypalAccount>
                    </account>
                </linkExternalAccountRequest>
            </sch:linkExternalAccount>
    </soapenv:Body>
</soapenv:Envelope>

Sample Response

<sch:linkExternalAccountResponse>
         <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>
            <!--Optional:-->
            <id>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
               <!--Optional:-->
               <subscriberReferenceId>?</subscriberReferenceId>
            </id>
         </return>
</sch:linkExternalAccountResponse>

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

Sample Request

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

Sample Response

{
    "id": {
        "bancBoxId": ? ,
        "subscriberReferenceId" : ?
    },
    "requestId": ? ,
    "status" : ? ,
    "warnings" : [{
        "code": "?",
        "message": "?"
    }],
    "errors": [{
        "code": "?",
        "message": "?"
    }]
}