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/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/BBXPort?wsdl

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com"> 

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 

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

Sample Request

{"authentication":{"apiKey":"fd1c986a29bf5e8bb5d283d426a2b754","secret":"e19d5cd5af0378da05f63f891c7467af"},"subscriberId":200323,"clientId":{"bancBoxId":165030},"referenceId":"ext_acc","account":{"wireAccount":{"bankAccountDetails":{"routingNumber":"051000017","accountNumber":"2400119922","holderName":"DeepikaP","bankAccountType":"SAVING"},"address":{"line1":"122","city":"ATLANTA","state":"GA","zipcode":38910}}}}

Sample Response

{"id":{"bancBoxId":365098,"subscriberReferenceId":"ext_acc"},"requestId":1396270395756,"status":1,"warnings":null}