Back to documentation index


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) :
WSDL URL (SandBox) :

Sample Request

<soapenv:Envelope xmlns:soapenv="" xmlns:sch=""> 

Sample Response

<soap:Envelope xmlns:soap=""> 

Note:For REST, Content-type should be set to application/json
URL (Production) :
URL (SandBox) :

Sample Request


Sample Response