Finxera

Back to documentation index

linkPayee

Use the linkPayee API to link a new payee to a client.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify subscriber ID issued when Finxera account is created.
+ clientId Y Object Define either bancBoxId or subscriberReferenceId parameter.
referenceId N String This is a subscriber created ID for the new linked payee (Max length:45)
+ payee Y Object Payee

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 The IDs for the new linked payee.

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

Sample Request

<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:sch="schema.bancbox.com"><soapenv:Header><wsse:Securitysoapenv:mustUnderstand="1"xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:UsernameTokenwsu:Id="XWSSGID-1261544568770-474929336"xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:Username>DP007</wsse:Username><wsse:PasswordType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">abcd1234</wsse:Password></wsse:UsernameToken></wsse:Security></soapenv:Header><soapenv:Body><sch:linkPayee><linkPayeeRequest><subscriberId>200318</subscriberId><clientId><!--Optional:--><bancBoxId>164740</bancBoxId></clientId><!--Optional:--><referenceId>link_p2_wire</referenceId><payee><payeeAccountNumber>2309</payeeAccountNumber><payee><!--YouhaveaCHOICEofthenext5itemsatthislevel--><wire><bankAccountDetails><routingNumber>051000017</routingNumber><accountNumber>2456091872</accountNumber><holderName>Deepika</holderName><bankAccountType>SAVING</bankAccountType></bankAccountDetails><address><line1>12ST</line1><!--Optional:--><line2>ROAD</line2><city>ATLANTA</city><state>GA</state><zipcode>23890</zipcode></address></wire></payee></payee></linkPayeeRequest></sch:linkPayee></soapenv:Body></soapenv:Envelope>

Sample Response

<soap:Envelopexmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns1:linkPayeeResponsexmlns:ns1="schema.bancbox.com"><returnxsi:type="ns3:linkPayeeResponse"xmlns:ns3="schema.bancbox.com"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><requestId>1396248845191</requestId><status>1</status><id><bancBoxId>106101</bancBoxId><subscriberReferenceId>link_p2_wire</subscriberReferenceId></id></return></ns1:linkPayeeResponse></soap:Body></soap:Envelope>

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

Sample Request

{"authentication":{"apiKey":"fd1c986a29bf5e8bb5d283d426a2b754","secret":"e19d5cd5af0378da05f63f891c7467af"},"subscriberId":200323,"clientId":{"bancBoxId":165030},"referenceId":"link_payee","payeeAccountNumber":"2098134516","payee":{"wire":{"bankAccountDetails":{"routingNumber":"051000017","accountNumber":"2456091872","holderName":"Deepika","bankAccountType":"SAVING"},"address":{"line1":"12 ST","line2":"ROAD","city":"ATLANTA","state":"GA","zipcode":23890}}}}

Sample Response

{"id":{"bancBoxId":106105,"subscriberReferenceId":"link_payee"},"requestId":1396251093874,"status":1,"warnings":null}