APIs to interact with FV Bank programmatically. As a business account holder you can request for the API access to your account.
\nNote: Merchant Partner will be referred as Client hereafter in this document.
\nClient has to call the GET AUTH TOKEN endpoint to receive the session token. The session token will be required as bearer token in all the other calls.
\nClient will be given with ClientID, ClientSecretKey upon enabling API Access. These will be needed to sign a payload to create a JWT that will be used in the GET AUTH TOKEN endpoint. Further details on the endpoint are given in the relevant section.
\nAPIs uses the http response codes to indicate if the requests are successful or failed. If the response codes are ~200, then the submitted requests are completed successfully.
\nAll the responses are returned in below format
\n{\n \"ResponseCode\": 200, // number\n \"ResponseMessage\": \"Successful\", // string\n \"ResponseData\": {} // object or array\n}\n\nin case there is some error the above response will have the ResponseError in place of ResponseData, which will be always be array of strings. For example:
\n{\n \"ResponseCode\": 401, // number\n \"ResponseMessage\": \"Successful\", // string\n \"ResponseError\": [ \"header['authorization']: 'missing authorization header'\" ] // array\n}\n\nAs a merchant partner you can refer individuals to sign up with FVBank with your referral code. The referral URL (which can be found in the My Profilesection on your login.) must contain UNIQUE REFERENCE ID from your system like employeeID, or username. Few endpoints in this API collection like check account balance, send payment, request payment uses this reference ID to perform the operations. Callbacks like member registration, KYC Status Updates, etc., will be sent to the merchant with this reference ID.
List of currency codes supported on the platform
\nUSD\n\nList of digital assets supported on the platform
\nTo get the SessionToken that is to be used in all other endpoints. This endpoint requires a header named AUTH-TOKEN which expected to be a JWT token of the below payload signed with the client secret that is shared by the FV Bank Team.
P.S AUTH-TOKEN is changed to X-AUTH-TOKEN. The former one is deprecated and removed.
{\n \"ClientID\": \"YOUR_CLIENT_ID\",\n \"iat\": CURRENT_TIMESTAMP,\n \"exp\":CURRENT_TIMESTAMP + 30 \\* 60 \\* 60 \\* 24\n}\n\nNote: HS256 is the algorithm to be used while generating JWT.
SessionToken returned from the API is valid for 15 minutes.
The x-refresh-token header will be present in the other endpoints before 2 minutes of the current token expiry, the same can be replaced with existing one.
Note that calls to the secured endpoints requires the same IP address that was used to obtain the session token.
\n","urlObject":{"path":["v2","auth"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"039bf851-276a-47ff-9cd8-2f3e1f83ff6e","name":"Get Session Token","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{authToken}}","type":"text"}],"url":"{{baseURL}}/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"278"},{"key":"etag","value":"W/\"116-wryw7XWU88NWapM89RrHdfosafE\""},{"key":"x-execution-time","value":"143"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Thu, 25 Nov 2021 10:41:22 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": {\n \"SessionToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDbGllbnRJRCI6ImRlY2EzNWZkLTMzMGItNDA2My04ZmRhLWZjMGQxYjYxMDcyYyIsImlhdCI6MTYzNzgzNjg4MiwiZXhwIjoxNjM3ODM3NzgyfQ.9c97iKdf-IAdvVz7O_QvjB-zL7e4OQAEukBCD3qXIa8\"\n }\n}"},{"id":"7a6b0afa-9f21-43ef-aec3-13ebc9cd3deb","name":"Get Session Token - Incorrect Token","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"fsdfdsfsdf.asfsadfasdfsda.asfasdfasdfsdf","type":"text"}],"url":"{{baseURL}}/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"106"},{"key":"etag","value":"W/\"6a-C4LASMCPnCyFHADljvpEV/Iba3c\""},{"key":"x-execution-time","value":"14"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Wed, 01 Dec 2021 05:50:30 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 400,\n \"ResponseMessage\": \"BadRequest\",\n \"ResponseErrors\": [\n \"headers[auth-token]: Bad Request.\"\n ]\n}"}],"_postman_id":"e8f68a06-aa2e-4235-91f8-b60115ac8eb9"},{"name":"Ping","event":[{"listen":"prerequest","script":{"id":"398b1175-f681-4a6e-b5e1-edf25dd5d919","exec":["// JWT generation script adapted from","// https://gist.github.com/corbanb/db03150abbe899285d6a86cc480f674d","","var jwtSecret = pm.environment.get('clientSecret') || ''","","// Set headers for JWT","var header = {","\t'typ': 'JWT',","\t'alg': 'HS256'","};","","// Prepare timestamp in seconds","var currentTimestamp = Math.floor(Date.now() / 1000)","","var data = {"," 'ClientID': pm.environment.get('clientID'),","\t'iat': currentTimestamp,","\t'exp': currentTimestamp + 30, // expiry time is 30 seconds from time of creation","}","","function base64url(source) {"," // Encode in classical base64"," encodedSource = CryptoJS.enc.Base64.stringify(source)"," "," // Remove padding equal characters"," encodedSource = encodedSource.replace(/=+$/, '')"," "," // Replace characters according to base64url specifications"," encodedSource = encodedSource.replace(/\\+/g, '-')"," encodedSource = encodedSource.replace(/\\//g, '_')"," "," return encodedSource","}","","// encode header","var stringifiedHeader = CryptoJS.enc.Utf8.parse(JSON.stringify(header))","var encodedHeader = base64url(stringifiedHeader)","","// encode data","var stringifiedData = CryptoJS.enc.Utf8.parse(JSON.stringify(data))","var encodedData = base64url(stringifiedData)","","// build token","var token = `${encodedHeader}.${encodedData}`","","// sign token","var signature = CryptoJS.HmacSHA256(token, jwtSecret)","signature = base64url(signature)","var signedToken = `${token}.${signature}`","","pm.environment.set('authToken', signedToken)","console.log('Signed and encoded JWT', signedToken)"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"dafe3b44-3733-4132-91a1-d39e347e7329","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3319a54f-373a-41eb-8fce-63e40dfbfd95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{authToken}}","type":"text"}],"url":"{{baseURL}}/v2/ping","description":"To get the SessionToken that is to be used in all other endpoints. This endpoint requires a header named AUTH-TOKEN which expected to be a JWT token of the below payload signed with the client secret that is shared by the FV Bank Team.
P.S AUTH-TOKEN is changed to X-AUTH-TOKEN. The former one is deprecated and removed.
{\n \"ClientID\": \"YOUR_CLIENT_ID\",\n \"iat\": CURRENT_TIMESTAMP,\n \"exp\":CURRENT_TIMESTAMP + 30 \\* 60 \\* 60 \\* 24\n}\n\nNote: HS256 is the algorithm to be used while generating JWT.
SessionToken returned from the API is valid for 15 minutes.
The x-refresh-token header will be present in the other endpoints before 2 minutes of the current token expiry, the same can be replaced with existing one.
Note that calls to the secured endpoints requires the same IP address that was used to obtain the session token.
\n","urlObject":{"path":["v2","ping"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"c954c489-fe6a-450b-b433-d3b23fa54133","name":"Get Session Token","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"{{authToken}}","type":"text"}],"url":"{{baseURL}}/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"278"},{"key":"etag","value":"W/\"116-wryw7XWU88NWapM89RrHdfosafE\""},{"key":"x-execution-time","value":"143"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Thu, 25 Nov 2021 10:41:22 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": {\n \"SessionToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDbGllbnRJRCI6ImRlY2EzNWZkLTMzMGItNDA2My04ZmRhLWZjMGQxYjYxMDcyYyIsImlhdCI6MTYzNzgzNjg4MiwiZXhwIjoxNjM3ODM3NzgyfQ.9c97iKdf-IAdvVz7O_QvjB-zL7e4OQAEukBCD3qXIa8\"\n }\n}"},{"id":"8bf3f6f4-11bf-4ff4-bc3c-0611f0753647","name":"Get Session Token - Incorrect Token","originalRequest":{"method":"GET","header":[{"key":"X-AUTH-TOKEN","value":"fsdfdsfsdf.asfsadfasdfsda.asfasdfasdfsdf","type":"text"}],"url":"{{baseURL}}/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"106"},{"key":"etag","value":"W/\"6a-C4LASMCPnCyFHADljvpEV/Iba3c\""},{"key":"x-execution-time","value":"14"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Wed, 01 Dec 2021 05:50:30 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 400,\n \"ResponseMessage\": \"BadRequest\",\n \"ResponseErrors\": [\n \"headers[auth-token]: Bad Request.\"\n ]\n}"}],"_postman_id":"3319a54f-373a-41eb-8fce-63e40dfbfd95"}],"id":"c28e2f3e-96d3-4599-952b-f2dea14faaf1","_postman_id":"c28e2f3e-96d3-4599-952b-f2dea14faaf1","description":""},{"name":"Secured","item":[{"name":"V2","item":[{"name":"Accounts","item":[{"name":"Get Account Balance","id":"01b648c7-13c9-4676-846d-365fd35afc40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/account/balance","description":"To get the account balance of the client. While the API returns all three types of balances (balance, reserved, available) for the merchant partner, it is advised to check against the availableBalance before performing any transactions.
\nReserved balance - Several transactions needs authorizations from the bank / the payer. Amounts of such transactions get added in the reserved balance.
\nAvailable balance - Balance that can considered before performing any transactions.
\nBalance - Total balance on the account which is the sum of reserved, and available balances.
\nTo get the deposit instructions for the client
\nThis endpoint provides the list of fields that are needed in the Create Beneficiary endpoint.
\nIn-order to make transfer it is required to create the beneficiary first. This endpoint creates the beneficiary. Please refer to the examples for creatiing beneficiary with or without virtual account associated with it
\nNote: A virtual account will be created if you include the 'Beneficiary_Document' field in the request body and the Virtual Account service is activated for your account.
\nNote: Use Get Bank Details endpoint to fetch beneficiary bank details using routing number.
\nVirtual accounts are a solution that enables account holders to generate unique account numbers for receiving third-party deposits while maintaining centralized fund management. Each virtual account is linked to a specific beneficiary relationship—whether a vendor or customer—and comes with dedicated deposit instructions accessible through web portals, mobile applications, and APIs. When funds are deposited using a virtual account reference, the system automatically routes these payments to the parent account holder's primary USD bank account. This creates a seamless collection mechanism for multiple payment sources without the complexity of managing separate physical bank accounts.
\nThis endpoint takes in the beneficiary type and returns all the fields required to add a virtual account to an already existing beneficiary
\nNote: Please refer to attached examples for the exact values
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","beneficiary","get-required-fields-for-virtual-account"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"1a76a860-3dce-41f3-91f5-7b9ed58c1ea1","name":"Get Required Fields (Add Virtual Account - Business)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryType\": \"business\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/get-required-fields-for-virtual-account"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"access-control-allow-credentials","value":"true"},{"key":"cache-control","value":"private"},{"key":"content-encoding","value":"gzip"},{"key":"content-security-policy","value":"default-src 'self'; script-src 'self'; object-src 'none'; base-uri 'none';"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"etag","value":"W/\"43d-AUl45MDbwGZt4ajPdVKBvJtOzaQ\""},{"key":"expect-ct","value":"max-age=0"},{"key":"function-execution-id","value":"0oqdwluqcn7f"},{"key":"origin-agent-cluster","value":"?1"},{"key":"permissions-policy","value":"geolocation=(self), microphone=(), camera=()"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-cloud-trace-context","value":"0861a06c481efc3ee7d74fe413a1201c"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-country-code","value":"US"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-execution-time","value":"1473"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-powered-by","value":"Express"},{"key":"x-xss-protection","value":"0"},{"key":"accept-ranges","value":"bytes"},{"key":"date","value":"Wed, 20 May 2026 10:13:01 GMT"},{"key":"x-served-by","value":"cache-chi-kigq8000042-CHI"},{"key":"x-cache","value":"MISS"},{"key":"x-cache-hits","value":"0"},{"key":"x-timer","value":"S1779271979.486124,VS0,VE1541"},{"key":"vary","value":"Origin, Accept-Encoding,cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400, h3=\":443\"; ma=2592000, h3=\":443\"; ma=2592000"},{"key":"x-request-id","value":"7da3e8cc-1b18-4959-94e2-548eae6e3155"},{"key":"via","value":"1.1 google, 1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": {\n \"Fields\": [\n {\n \"Name\": \"Beneficiary_Business_Document\",\n \"Required\": true,\n \"Type\": \"Object\",\n \"Fields\": [\n {\n \"Name\": \"Document_Type\",\n \"Required\": true,\n \"Type\": \"SingleSelection\",\n \"PossibleValues\": [\n {\n \"label\": \"Articles of Incorporation\",\n \"value\": \"Articles_Of_Incorporation\"\n },\n {\n \"label\": \"Bylaws\",\n \"value\": \"Bylaws\"\n },\n {\n \"label\": \"Partnership Agreements\",\n \"value\": \"Partnership_Agreements\"\n },\n {\n \"label\": \"Operating Agreement\",\n \"value\": \"Operating_Agreement\"\n },\n {\n \"label\": \"Certificate of Incorporation\",\n \"value\": \"Certificate_Of_Incorporation\"\n },\n {\n \"label\": \"Business Registration Certificate\",\n \"value\": \"Business_Registration_Certificate\"\n },\n {\n \"label\": \"Proof of Business Registration and Legal Existence\",\n \"value\": \"Proof_Of_Business_Registration\"\n }\n ]\n },\n {\n \"Name\": \"Document_Number\",\n \"Required\": true,\n \"Type\": \"Text\"\n },\n {\n \"Name\": \"Document_Expiration_Date\",\n \"Required\": true,\n \"Type\": \"Date\"\n },\n {\n \"Name\": \"Document_File\",\n \"Required\": true,\n \"Type\": \"File\",\n \"MaxFiles\": 1,\n \"Accept\": [\n \"application/pdf\",\n \"image/gif\",\n \"image/jpeg\",\n \"image/pjpeg\",\n \"image/png\",\n \"image/x-png\",\n \"image/bmp\",\n \"image/webp\",\n \"image/svg+xml\"\n ]\n }\n ]\n }\n ]\n }\n}"},{"id":"cd74b03d-0b9d-4223-a9d7-4b889868444e","name":"Get Required Fields (Add Virtual Account - Individual)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryType\": \"individual\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/get-required-fields-for-virtual-account"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"content-length","value":"894"},{"key":"access-control-allow-credentials","value":"true"},{"key":"cache-control","value":"private"},{"key":"content-security-policy","value":"default-src 'self'; script-src 'self'; object-src 'none'; base-uri 'none';"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"etag","value":"W/\"37e-7CO0p7HdjMBngByMTF8oNgWjs44\""},{"key":"expect-ct","value":"max-age=0"},{"key":"function-execution-id","value":"0oqdt43ht2kb"},{"key":"origin-agent-cluster","value":"?1"},{"key":"permissions-policy","value":"geolocation=(self), microphone=(), camera=()"},{"key":"referrer-policy","value":"no-referrer"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-cloud-trace-context","value":"c8a639e256adfa5ac1fb4123932bb39a;o=1"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-country-code","value":"US"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"x-download-options","value":"noopen"},{"key":"x-execution-time","value":"1366"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"x-powered-by","value":"Express"},{"key":"x-xss-protection","value":"0"},{"key":"accept-ranges","value":"bytes"},{"key":"date","value":"Wed, 20 May 2026 10:13:33 GMT"},{"key":"x-served-by","value":"cache-chi-klot8100123-CHI"},{"key":"x-cache","value":"MISS"},{"key":"x-cache-hits","value":"0"},{"key":"x-timer","value":"S1779272012.135825,VS0,VE1423"},{"key":"vary","value":"Origin, Accept-Encoding,cookie,need-authorization, x-fh-requested-host, accept-encoding"},{"key":"alt-svc","value":"h3=\":443\";ma=86400,h3-29=\":443\";ma=86400,h3-27=\":443\";ma=86400, h3=\":443\"; ma=2592000, h3=\":443\"; ma=2592000"},{"key":"x-request-id","value":"e7fc8135-606d-44b8-b96b-b65909830e85"},{"key":"via","value":"1.1 google, 1.1 google"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": {\n \"Fields\": [\n {\n \"Name\": \"Beneficiary_DOB\",\n \"Required\": true,\n \"Type\": \"Date\"\n },\n {\n \"Name\": \"Beneficiary_ID_Document\",\n \"Required\": true,\n \"Type\": \"Object\",\n \"Fields\": [\n {\n \"Name\": \"ID_Type\",\n \"Required\": true,\n \"Type\": \"SingleSelection\",\n \"PossibleValues\": [\n {\n \"label\": \"Passport\",\n \"value\": \"passport\"\n },\n {\n \"label\": \"License\",\n \"value\": \"Driving_License\"\n }\n ]\n },\n {\n \"Name\": \"ID_Number\",\n \"Required\": true,\n \"Type\": \"Text\"\n },\n {\n \"Name\": \"ID_Expiration_Date\",\n \"Required\": true,\n \"Type\": \"Date\"\n },\n {\n \"Name\": \"Front_Document\",\n \"Required\": true,\n \"Type\": \"File\",\n \"MaxFiles\": 1,\n \"Accept\": [\n \"application/pdf\",\n \"image/gif\",\n \"image/jpeg\",\n \"image/pjpeg\",\n \"image/png\",\n \"image/x-png\",\n \"image/bmp\",\n \"image/webp\",\n \"image/svg+xml\"\n ]\n },\n {\n \"Name\": \"Back_Document\",\n \"Required\": true,\n \"Type\": \"File\",\n \"MaxFiles\": 1,\n \"Accept\": [\n \"application/pdf\",\n \"image/gif\",\n \"image/jpeg\",\n \"image/pjpeg\",\n \"image/png\",\n \"image/x-png\",\n \"image/bmp\",\n \"image/webp\",\n \"image/svg+xml\"\n ]\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"fb22391c-c706-4012-baab-58250a58c4e0"},{"name":"Add Virtual Account","event":[{"listen":"test","script":{"id":"bc5ec706-348f-41b0-91c9-2501b536b28f","exec":["var jsonData = pm.response.json();","if(jsonData?.ResponseData?.BeneficiaryId){"," pm.environment.set(\"beneficiaryIDV2\", jsonData.ResponseData.BeneficiaryId);"," }"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4293af3c-0517-4b41-8fc3-4e7fbdf2aa87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"field\": \"Beneficiary_Type\",\n \"value\": \"Business\"\n },\n {\n \"field\": \"Beneficiary_Document\",\n \"value\": [\n {\n \"field\": \"Document_Type\",\n \"value\": \"Certificate_Of_Incorporation\"\n },\n {\n \"field\": \"Document_Number\",\n \"value\": \"X12345679\"\n },\n {\n \"field\": \"Document_Expiration_Date\",\n \"value\": \"2027-12-01\"\n },\n {\n \"field\": \"Document_File\",\n \"value\": \"{{FileId}}\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/add-virtual-account/{{beneficiaryIDV2}}","description":"This endpoint add a virtual account to an existing beneficiary
\nNote: Please refer to the attached examples for exact values.
\nReturns all the active beneficiaries that are added with the merchant account.
\nTo get the details of a beneficiary.
\nThis endpoint is used to change status of a beneficiary.
\nNote: \"Permission Denied\" message is returned with status code 400 when \"Status\" in request body is same as the beneficiary status.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","beneficiary","change-status"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"be1da2a0-8914-4025-9dfd-ed808664f21d","name":"Change Status [Enable]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"BeneficiaryId\": \"{{beneficiaryIDV2}}\",\n \"Status\": \"Active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/change-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"origin-agent-cluster","value":"?1"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"125"},{"key":"etag","value":"W/\"7d-ltQTCG9BD7gLU6koSV+BMpZiICo\""},{"key":"x-execution-time","value":"11605"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Tue, 10 Jan 2023 07:36:09 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": \"Beneficiary has been enabled for transactions successfully.\"\n}"},{"id":"22a6efdf-5281-496e-8c90-bbaee019f4dc","name":"Change Status [Disable]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"BeneficiaryId\": \"{{beneficiaryIDV2}}\",\n \"Status\": \"Disable\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/change-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"origin-agent-cluster","value":"?1"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"126"},{"key":"etag","value":"W/\"7e-w6n4xiKyJ+JzIJ/BS7VEB5HXjpg\""},{"key":"x-execution-time","value":"6143"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Tue, 10 Jan 2023 07:36:59 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": \"Beneficiary has been disabled for transactions successfully.\"\n}"}],"_postman_id":"513bd899-785e-48c9-b381-6816d21416af"}],"id":"59115288-2a9d-4f17-90bc-5e150d22ac75","description":"In order to initiate a bank transfer, a beneficiary must be added first. This sections consists of endpoints to work with the beneficiaries
\n","_postman_id":"59115288-2a9d-4f17-90bc-5e150d22ac75","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Payment Instrument","item":[{"name":"Get Required Fields [V2]","id":"200ff2f2-fe1c-41f2-8541-3a1718484ee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"PaymentType\": \"BUS_USD_Account.payment_cross_border_brl_domestic_payments\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/payment-instrument/get-required-fields","description":"This endpoint is used to get all the fields that are needed to create a payment instrument based on the payment type.
\nThis endpoint is used to create a payment instrument associated with a beneficiary.
\nAdditional Info
\nAdditional_Info is an optional field. However, it becomes required if the bank details cannot be automatically retrieved using the provided Routing Number or SWIFT Code.
\nIn such cases, you must include the bank details inside the additional_info object.
Bank_Name
Bank_Address
Bank_City
Bank_State
Bank_Postal_Code
Bank_Country
{ \"additional_info\": { \"Bank_Name\": \"Example Bank\", \"Bank_Address\": \"123 Main Street\", \"Bank_City\": \"New York\", \"Bank_State\": \"NY\", \"Bank_Postal_Code\": \"10001\", \"Bank_Country\": \"US\" } }
Note: Use Get Bank Details endpoint to fetch beneficiary bank details using routing number.
\nThis endpoint is used to get the list of payment instruments associated with a particular beneficiary.
\nThis endpoint is used to get detailed information about a payment instrument.
\nThis endpoint is used to change status of a payment instrument ID
\nNote: \"Permission Denied\" message is returned with status code 400 when \"Status\" in request body is same as the Payment Instrument status.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","payment-instrument","change-status"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"bae6b72a-f3f5-4c26-aa94-7ccee4f8f07b","name":"Change Status [Enable]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"BeneficiaryId\": \"{{beneficiaryIDV2}}\",\n \"Status\": \"Active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/change-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"origin-agent-cluster","value":"?1"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"125"},{"key":"etag","value":"W/\"7d-ltQTCG9BD7gLU6koSV+BMpZiICo\""},{"key":"x-execution-time","value":"11605"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Tue, 10 Jan 2023 07:36:09 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": \"Beneficiary has been enabled for transactions successfully.\"\n}"},{"id":"0850d617-259a-43f2-b189-3c84040d601b","name":"Change Status [Disable]","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"BeneficiaryId\": \"{{beneficiaryIDV2}}\",\n \"Status\": \"Disable\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/beneficiary/change-status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"origin-agent-cluster","value":"?1"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"126"},{"key":"etag","value":"W/\"7e-w6n4xiKyJ+JzIJ/BS7VEB5HXjpg\""},{"key":"x-execution-time","value":"6143"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Tue, 10 Jan 2023 07:36:59 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": \"Beneficiary has been disabled for transactions successfully.\"\n}"}],"_postman_id":"b58ac586-5caa-4b60-a85e-325c7ff9d91d"}],"id":"4cbb1435-d966-43ff-a9ae-d00304a7fc8d","description":"Payment instruments comprise different payment types inside a beneficiary. Payment instrument contains information related to bank account and payment type along with information needed to perform a payment.
\n","_postman_id":"4cbb1435-d966-43ff-a9ae-d00304a7fc8d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Custody","item":[{"name":"Get Custody Account Status","id":"2eb09591-60a4-4591-bd6d-8755befa5624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Asset\": \"BTC\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/custody/status","description":"This endpoint is used to get custody application status and balance of the custody account.
\nThis endpoint is used to apply for a custody application
\nThis endpoint is used to preview a custody transaction and fee to be applied for the transaction
\nThis endpoint is used to transfer digital assets using a custody payment instrument.
\nThese endpoints are used to apply for custody accounts and perform digital asset payments to different address using payment instruments
\n","_postman_id":"2cfc46c7-ccaf-42b9-9d6f-f5c8996972b8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Resource","item":[{"name":"Get Countries For Beneficiary","id":"d8896325-0e18-4fb6-93a3-e7139ab5fa43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/resource/countries/beneficiary","description":"To fetch the list of countries that are allowed to create beneficiary (to initiate payments/transfer).
\nTo fetch the list of countries that are allowed to send payments/transfers.
\nTo fetch the list of possible payment types that can be created in the system.
\nTo fetch the list of possible payment purpose codes that can be used while creating the payments/transfers in the system.
\nThese are the endpoints which provides the values required on the other endpoints.
\n","_postman_id":"d8ee287b-3af5-43a8-85c5-6a4fc95f81e9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Transactions","item":[{"name":"Get Transaction Details","id":"bd063678-b8ab-4035-903f-02dbf7f60303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/transactions/details/:transactionNumber","description":"To get the details about a transaction. Transaction number can be any of the response from payment or transfer endpoint.
\nReturns all the transactions that were incomplete, rejected, canceled, or failed.
\nReturns all the completed transactions of the client.
\nUse the Send Webhook endpoint to easily trigger the webhook for the the latest transaction state by providing the transaction number in the request body,
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","transactions","send-webhook"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[{"id":"0ae5242b-5d14-4b15-9f2f-30f4710a6007","name":"Re-Send Webhook (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"TransactionNumber\": \"FV000020154\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/transactions/send-webhook"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-powered-by","value":"Express"},{"key":"content-security-policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"cross-origin-embedder-policy","value":"require-corp"},{"key":"cross-origin-opener-policy","value":"same-origin"},{"key":"cross-origin-resource-policy","value":"same-origin"},{"key":"x-dns-prefetch-control","value":"off"},{"key":"expect-ct","value":"max-age=0"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"strict-transport-security","value":"max-age=15552000; includeSubDomains"},{"key":"x-download-options","value":"noopen"},{"key":"x-content-type-options","value":"nosniff"},{"key":"origin-agent-cluster","value":"?1"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"no-referrer"},{"key":"x-xss-protection","value":"0"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"116"},{"key":"etag","value":"W/\"74-RM6pp/NbpR72hc7o6I/mYvikHNU\""},{"key":"x-execution-time","value":"1076"},{"key":"vary","value":"Accept-Encoding, Authorization, Cookie"},{"key":"date","value":"Wed, 08 Nov 2023 09:25:24 GMT"},{"key":"connection","value":"keep-alive"},{"key":"keep-alive","value":"timeout=5"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"ResponseCode\": 200,\n \"ResponseMessage\": \"Success\",\n \"ResponseData\": {\n \"WebhookId\": \"7bdeb64f-50b2-4624-87ea-4fa111282e8e\"\n }\n}"}],"_postman_id":"8056cb9e-afa9-4caa-9da7-1368947d46e7"}],"id":"aebbe1e4-85c4-4764-b697-b213e6d7f220","_postman_id":"aebbe1e4-85c4-4764-b697-b213e6d7f220","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Sandbox","item":[{"name":"Deposit Payment Types[Test Env Only]","id":"4f3e4ddb-4f0e-4385-8015-2f2b9f4a9dd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/sandbox/deposit/depositTypes","description":"Returns all the possible deposit payment types in the system.
\nTo create a deposit transaction to the client account
\nAuthorizes a pending transaction created in sandbox environment
\nDeny a pending transaction created in sandbox environment
\nCancel a pending transaction created in sandbox environment.
\nNote: FVNet transaction can only be denied by user to whom the transaction is directed to.
\nAPIs to help partners in testing and exploring the workflows in FVBank's Merchant partner APIs. These endpoints only work in Sandbox environment.
\n","_postman_id":"d506b990-e77a-44ed-aad2-d0f22678483b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Payments","item":[{"name":"Preview - Send Bank Payment [V2]","event":[{"listen":"test","script":{"id":"ecb1eb98-eb13-4b34-a6f5-62402ba877e8","exec":["var jsonData = pm.response.json();","pm.environment.set(\"transactionNumber\", jsonData.ResponseData.TransactionNumber);"],"type":"text/javascript","packages":{}}}],"id":"b1f07868-5554-4773-a88b-24a828f2cecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryPaymentInstrumentID\": \"{{PaymentInstrumentID}}\",\n \"Purpose\": \"Loan_Payments\",\n \"Currency\": \"USD\",\n \"Amount\": \"300\",\n \"CryptoBuySellActivity\": \"No\",\n \"SupportingDocument\": \"{{FileId}}\",\n \"DocumentReferenceNumber\":\"1123123\",\n \"Intermediary_ABA\": \"026001591\",\n \"Description\": \"lorem ipsum dummy text\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/payment/bank/preview","description":"This endpoint requires the same request body as create bank transfer endpoint. The difference between them is the former one validates the request body (provides error message if any), lists the fee involved, and the details of the transaction.
\nThe endpoint is used to make the payment to the beneficiary that was added early using any of the payment instrument Id associated with that beneficiary. The associated beneficiary status must be Enabled to send the payment.
Note:
1. The payment might need one or more authorization from the bank. Merchant partner will be notified on such changes via callbacks to the designated URL.
2. Swift code provided while creating payment instrument will also get verfied in this endpoint.
These endpoints are used to create a transaction for different payment types using a payment instrument.
\n","_postman_id":"06a87c95-753d-44a1-a31e-c1e428a6e962","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Cross Border Payments","item":[{"name":"Preview - Send Cross Border Payment","id":"af5dbf60-e5bb-4586-bbf0-aca2cc85fc51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryPaymentInstrumentID\": \"{{PaymentInstrumentID}}\",\n \"Purpose\": \"Savings\",\n \"Description\": \"Testing Payment endpoint (Business Endpoint)\",\n \"DestinationAmount\": \"120\",\n \"CryptoBuySellActivity\": \"Yes\",\n \"SupportingDocument\": \"{{FileId}}\"\n}\n\n\n\n","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/cross-border/preview","description":"The \"Preview - Send SEPA Payment\" endpoint is a significant component in managing SEPA (Single Euro Payments Area) transactions efficiently. In the initial step, users provide essential details, including the Payment Instrument ID, payment purpose, description, destination amount and destination currencies, and the transaction amount.
\nUpon a successful request, the endpoint returns a comprehensive preview of the SEPA transaction, encompassing critical details such as fees, exchange rates, and the newly generated QuoteID.
\nThe \"SEND Cross Border Payment\" endpoint offers users the capability to initiate cross-border transactions with precision. Users can input essential transaction details, including the Payment Instrument ID, payment purpose, description, destination amount, destination currency, and CryptoBuySellActivity flag.
\nThe \"SupportingDocument\" attribute allows for the attachment of relevant documents using the File ID obtained from the \"Upload File\" endpoint. Importantly, if users do not specify a Quote ID in the request body, the endpoint will generate a new Quote ID automatically.
\nThese endpoints are used to create a transaction for different payment types using a payment instrument.
\n","_postman_id":"0edf5e5a-9f91-4b04-8898-0c5e93ee7075","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Stablecoin","item":[{"name":"Preview- Stablecoin Withdraw","id":"ec701f37-bc81-4d12-a0bd-fe13d238bb60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryPaymentInstrumentID\": \"{{PaymentInstrumentID}}\",\n \"Amount\": \"400\",\n \"Description\": \"Testing apis\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/stablecoin/withdraw/preview","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","stablecoin","withdraw","preview"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec701f37-bc81-4d12-a0bd-fe13d238bb60"},{"name":"Transfer - Stablecoin Withdraw","id":"118b1b66-1a3a-447e-8439-79244e59aaf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"BeneficiaryPaymentInstrumentID\": \"{{PaymentInstrumentID}}\",\n \"Amount\": \"0.01\",\n \"Description\": \"Testing apis\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseURL}}/v2/stablecoin/withdraw","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","stablecoin","withdraw"],"host":["{{baseURL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"118b1b66-1a3a-447e-8439-79244e59aaf9"}],"id":"bb9dd4df-8f14-497d-a6e7-d59f60a7b8ba","_postman_id":"bb9dd4df-8f14-497d-a6e7-d59f60a7b8ba","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}},{"name":"Files","item":[{"name":"Get File","id":"d4f57a21-f623-45eb-90c2-e2d1c9de2104","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/files/:FileId","description":"This endpoint takes a temp file ID as a path variable and returns the image or document that was previously uploaded using the Upload File endpoint. The response will contain the file in its original format.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","files",":FileId"],"host":["{{baseURL}}"],"query":[],"variable":[{"type":"any","value":"{{FileId}}","key":"FileId"}]}},"response":[],"_postman_id":"d4f57a21-f623-45eb-90c2-e2d1c9de2104"},{"name":"Get File Details","id":"04f582c8-7e75-4744-98fc-1356de9d1cc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseURL}}/v2/files/details/:FileId","description":"This endpoint takes a temp file ID as a path variable and returns details about the file such as its name and format. The response will contain metadata about the file that was previously uploaded using the Upload File endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","files","details",":FileId"],"host":["{{baseURL}}"],"query":[],"variable":[{"type":"any","value":"{{FileId}}","key":"FileId"}]}},"response":[],"_postman_id":"04f582c8-7e75-4744-98fc-1356de9d1cc1"},{"name":"Upload File","event":[{"listen":"test","script":{"id":"20830f33-a27f-4e0d-a818-2958b4ab1058","exec":["var jsonData = pm.response.json();","if(!!jsonData?.ResponseData?.ID){"," pm.environment.set(\"FileId\", jsonData.ResponseData.ID);","}",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"872a7656-8898-4ee8-b949-d7834afadf97","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"file","file":{"src":"/Users/rajesh/Downloads/dummy-pdf_2.pdf"}},"url":"{{baseURL}}/v2/files/upload?customField=Payment_Invoice&fileName=Ducket.pdf","description":"This endpoint is used to upload files and retrieve file IDs, which can then be used in the file-type parameters of other endpoints.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}},"urlObject":{"path":["v2","files","upload"],"host":["{{baseURL}}"],"query":[{"key":"customField","value":"Payment_Invoice"},{"key":"fileName","value":"Ducket.pdf"}],"variable":[]}},"response":[],"_postman_id":"872a7656-8898-4ee8-b949-d7834afadf97"}],"id":"5bd48785-eddc-47dd-bbb2-6f07723e2f66","description":"The \"Files\" section of this API provides functionality to upload and retrieve files in various formats such as png, jpg, jpeg and pdf. This section contains three endpoints which are described below:
\n","_postman_id":"5bd48785-eddc-47dd-bbb2-6f07723e2f66","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":true,"source":{"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f","id":"c7300481-4110-43f2-b783-e62c9851bd7f","name":"V2","type":"folder"}}}],"id":"c7300481-4110-43f2-b783-e62c9851bd7f","description":"Version 2 of the Merchant Partner APIs. It will contain beneficiary redesign along with other feature releases
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{sessionToken}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8e01e4ce-5d04-47b6-9caf-70d60980dec9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e90b8d6f-c0de-4737-b4c2-a0bf56703c56","type":"text/javascript","exec":["const refreshToken = pm.response.headers.get('x-refresh-token');","if (refreshToken){"," pm.environment.set(\"sessionToken\", refreshToken);"," console.log('token refershed');","}",""]}}],"_postman_id":"c7300481-4110-43f2-b783-e62c9851bd7f"}],"id":"2a4986ba-ff42-4bed-b647-c6cbbbb6c34a","description":"All the endpoints in this section will need the SessionToken obtained with the Auth endpoint.
\nNote: If the session token nears its expiry during any of the call, the response expected to contain a header named x-refresh-token This token can be replace with existing sessionToken and consumed accordingly. i.e., no need of another explicit call to auth to get the session token.
Client would receive below callbacks on the designated URL.
\nAll the response will now include x-signature on the header. Below is the sample code of how you can validate signature.
const crypto = await import('crypto');\nconst signature = res.headers['x-signature'];\nconst hmac = crypto.createHmac('sha256', CLIENT_SECRET);\nconst expectedSignature = hmac.update(JSON.stringify(res.body?.Data)).digest('hex');\nconst a = Buffer.from(signature);\nconst b = Buffer.from(expectedSignature);\nif (crypto.timingSafeEqual(a, b)) {\n console.log('Matched');\n} else {\n console.log('Signature Not Matched');\n}\n\nWhenever a new individual account signed with the client's referral link, the below body is posted
\n{\n \"Date\": \"2022-01-10T12:52:28\",\n \"Data\": {\n \"Email\": \"john.doe@outlook.com\",\n \"Name\": \"John Doe\",\n \"Phone\": \"+91 12345 12345\",\n \"ReferenceID\": \"SU0003\",\n \"AccountType\": \"Individual\"\n },\n \"Event\": \"MEMBER_REGISTERED\",\n \"Message\": \"New Member Registered with your referral code\"\n}\n\nAccount Type
\nWhenever there is change in the KYC status of the user, the below body is posted.
\n{\n \"Date\": \"2023-06-15T10:26:40\",\n \"Data\": {\n \"Email\": \"rishav_test@mailinator.uk\",\n \"Name\": \"Rishav_test\",\n \"Phone\": \"+1777137134\",\n \"ReferenceID\": \"emp4001\",\n \"AccountType\": \"Individual\",\n \"OldStatus\": \"FAILED_SESSION\",\n \"NewStatus\": \"COMPLETED\"\n },\n \"Event\": \"MEMBER_KYC_STATUS_CHANGED\",\n \"Id\": \"8209c2c3-a6d2-4c4c-be10-682917b4409e\",\n \"Message\": \"Member KYC Status Changed\"\n}\n\nKYC Statuses
\nThe client gets this callback whenever the user referred by them changes their email id.
\n{\n \"Date\": \"2023-06-15T10:23:16\",\n \"Data\": {\n \"Name\": \"Rishav_test\",\n \"Phone\": \"+1777137134\",\n \"ReferenceID\": \"emp4001\",\n \"AccountType\": \"Individual\",\n \"OldEmail\": \"RISHAV_TEST@MAILINATOR.CO\",\n \"NewEmail\": \"RISHAV_TEST@MAILINATOR.UK\"\n },\n \"Event\": \"MEMBER_EMAIL_UPDATED\",\n \"Id\": \"082ac4c6-56dd-47ec-9699-6036dbd46520\",\n \"Message\": \"Member Email Changed\"\n}\n\nBelow data get posted whenever there is a change in the client's referred account's financial status
\n{\n \"Date\": \"2023-06-15T09:57:40\",\n \"Data\": {\n \"Email\": \"rishav_test_usr@mailinator.com\",\n \"Name\": \"Rishav_test\",\n \"Phone\": \"+1777137134\",\n \"ReferenceID\": \"emp123456\",\n \"AccountType\": \"Individual\",\n \"OldStatus\": \"DISABLED\",\n \"NewStatus\": \"ENABLED\"\n },\n \"Event\": \"MEMBER_FINANCIAL_TRANSACTION_STATUS_CHANGED\",\n \"Id\": \"fc37aba0-ba0a-4f89-ad41-3878ed78fb58\",\n \"Message\": \"The member financial status changed\"\n}\n\nFinancial Statuses
\nBelow is the callback when the status of the member gets changed
\n{\n \"Date\": \"2023-06-15T10:38:10\",\n \"Data\": {\n \"Email\": \"rishav_test@mailinator.uk\",\n \"Name\": \"Rishav_test\",\n \"Phone\": \"+91 88988 98991\",\n \"ReferenceID\": \"emp4001\",\n \"AccountType\": \"Individual\",\n \"Status\": \"BLOCKED\"\n },\n \"Event\": \"MEMBER_STATUS_CHANGED\",\n \"Id\": \"a37c54dc-6963-4c40-9547-e536f09f7e6e\",\n \"Message\": \"The member status changed\"\n}\n\nMember status
\nWhenever there is an update in member's phone number
\n{\n \"Date\": \"2022-01-10T13:01:32\",\n \"Data\": {\n \"Name\": \"John Doe\",\n \"ReferenceID\": \"SU0003\",\n \"AccountType\": \"Individual\",\n \"OldPhone\": \"+12015550111\",\n \"NewPhone\": \"+12015550113\"\n },\n \"Event\": \"MEMBER_PHONE_UPDATED\",\n \"Message\": \"Member Phone Changed\"\n }\n\n {\n \"Date\": \"2022-01-10T13:03:35\",\n \"Data\": {\n \"Name\": \"John Doe\",\n \"Phone\": \"+91 12345 12345\",\n \"ReferenceID\": \"SU0003\",\n \"AccountType\": \"Individual\",\n \"DeletedPhone\": \"+12015550113\"\n },\n \"Event\": \"MEMBER_PHONE_DELETED\",\n \"Message\": \"Member Phone Deleted\"\n }\n\n{\n \"Date\": \"2023-06-15T10:38:10\",\n \"Data\": {\n \"Email\": \"rishav_test@mailinator.uk\",\n \"Name\": \"Rishav_test\",\n \"ReferenceID\": \"emp4001\",\n \"AccountType\": \"Individual\",\n \"NewPhone\": \"+917898878332\",\n \"PhoneType\": \"MOBILE\"\n },\n \"Event\": \"MEMBER_PHONE_ADDED\",\n \"Id\": \"a37c54dc-6963-4c40-9547-e536f09f7e6e\",\n \"Message\": \"The member phone added\"\n}\n\n {\n \"Date\": \"2023-06-15T07:46:18\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T07:46:18.150Z\",\n \"TransactionNumber\": \"FV000017423\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Johnie Rogan\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent payment\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"118877665101\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Johnie\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Johnie Rogan\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"Main Street, Second Main\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Bengaluru\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"560084\"\n },\n {\n \"label\": \"United States of America\",\n \"value\": \"US\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"THE BANK OF NEW YORK MELLON\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"240 GREENWICH STREET\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"NEW YORK\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"560084\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_CREATED\",\n \"Id\": \"03539a28-4453-425d-9720-15037d0ef027\",\n \"Message\": \"Transaction created\"\n}\n\n{\n \"Date\": \"2023-06-15T09:32:38\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T09:31:18.739Z\",\n \"TransactionNumber\": \"FV000017257\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Rishav Upadhayay\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent payments\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"20363486622\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Rishav\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Upadhayay\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"1437 VIP Road Ayodhya Kunj Agra\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Agra\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"282001\"\n },\n {\n \"label\": \"India\",\n \"value\": \"IN\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"Standard Chartered International (USA) Ltd\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"1095 Ave of the Americas\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"New York\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"10036\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_DENIED\",\n \"Id\": \"f194e193-1b22-4a61-a3e4-c81a5b79efc5\",\n \"Message\": \"Transaction denied\"\n}\n\n{\n \"Date\": \"2023-06-15T09:23:19\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T09:22:05.972Z\",\n \"TransactionNumber\": \"FV000017255\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Rishav Upadhayay\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent Payment\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"20363486622\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Rishav\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Upadhayay\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"1437 VIP Road Ayodhya Kunj Agra\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Agra\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"282001\"\n },\n {\n \"label\": \"India\",\n \"value\": \"IN\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"Standard Chartered International (USA) Ltd\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"1095 Ave of the Americas\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"New York\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"10036\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_AUTHORIZED\",\n \"Id\": \"6c33e3b0-f853-4513-95ec-0b9d20d32ccd\",\n \"Message\": \"Transaction authorized\"\n}\n\n{\n \"Date\": \"2022-05-18T07:32:22\",\n \"Data\": {\n \"CreatedDate\": \"2022-05-18T07:30:44.863Z\", \n \"NewStatus\": \"COMPLETED\",\n \"OldStatus\": \"IN PROCESS\"\n \"TransactionNumber\": \"FV000004645\",\n \"Type\": \"Payment - Domestic Wire\"\n },\n \"Event\": \"TRANSACTION_STATUS\",\n \"Message\": \"The member transaction status changed\"\n }\n\n{\n \"Date\": \"2023-06-15T09:34:53\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T09:34:24.448Z\",\n \"TransactionNumber\": \"FV000017258\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Rishav Upadhayay\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent Payment\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"20363486622\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Rishav\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Upadhayay\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"1437 VIP Road Ayodhya Kunj Agra\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Agra\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"282001\"\n },\n {\n \"label\": \"India\",\n \"value\": \"IN\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"Standard Chartered International (USA) Ltd\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"1095 Ave of the Americas\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"New York\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"10036\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_CANCELLED\",\n \"Id\": \"b9cca9de-8b7b-4a13-b3a4-8dc8b86ae57e\",\n \"Message\": \"Transaction cancelled\"\n}\n\n{\n \"Date\": \"2023-06-15T09:40:53\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T09:37:03.500Z\",\n \"TransactionNumber\": \"FV000017259\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Rishav Upadhayay\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent Payment\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"20363486622\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Rishav\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Upadhayay\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"1437 VIP Road Ayodhya Kunj Agra\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Agra\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"282001\"\n },\n {\n \"label\": \"India\",\n \"value\": \"IN\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"Standard Chartered International (USA) Ltd\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"1095 Ave of the Americas\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"New York\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"10036\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_EXPIRED\",\n \"Id\": \"c9de546a-3383-49ab-ab25-bab4211230bc\",\n \"Message\": \"Transaction returned\"\n}\n\n{\n \"Date\": \"2023-06-15T09:40:53\",\n \"Data\": {\n \"CreatedDate\": \"2023-06-15T09:37:03.500Z\",\n \"TransactionNumber\": \"FV000017259\",\n \"Type\": \"Payment - Domestic (ACH)\",\n \"Amount\": \"1.00\",\n \"From\": \"Rishav_Business - Rishav\",\n \"To\": \"Rishav Upadhayay\",\n \"Currency\": \"USD\",\n \"Description\": \"Rent Payment\",\n \"Purpose\": \"Savings\",\n \"AdditionalData\": [\n {\n \"label\": \"Routing Number\",\n \"value\": \"026001591\"\n },\n {\n \"label\": \"Account Number\",\n \"value\": \"20363486622\"\n },\n {\n \"label\": \"Bank_Account_Type\",\n \"value\": \"Saving\"\n },\n {\n \"label\": \"Beneficiary First Name\",\n \"value\": \"Rishav\"\n },\n {\n \"label\": \"Beneficiary Last Name\",\n \"value\": \"Upadhayay\"\n },\n {\n \"label\": \"Beneficiary Address\",\n \"value\": \"1437 VIP Road Ayodhya Kunj Agra\"\n },\n {\n \"label\": \"Beneficiary City\",\n \"value\": \"Agra\"\n },\n {\n \"label\": \"Beneficiary Postal Code\",\n \"value\": \"282001\"\n },\n {\n \"label\": \"India\",\n \"value\": \"IN\"\n },\n {\n \"label\": \"Beneficiary Bank Name\",\n \"value\": \"Standard Chartered International (USA) Ltd\"\n },\n {\n \"label\": \"Beneficiary Bank Address\",\n \"value\": \"1095 Ave of the Americas\"\n },\n {\n \"label\": \"Beneficiary Bank City\",\n \"value\": \"New York\"\n },\n {\n \"label\": \"Beneficiary Bank State\",\n \"value\": \"NY\"\n },\n {\n \"label\": \"Beneficiary Bank Postal Code\",\n \"value\": \"10036\"\n },\n {\n \"label\": \"Beneficiary Bank Country\",\n \"value\": \"United States of America\"\n },\n {\n \"label\": \"Beneficiary_Payment_Purpose\",\n \"value\": \"Savings\"\n }\n ]\n },\n \"Event\": \"TRANSACTION_RETURNED\",\n \"Id\": \"c9de546a-3383-49ab-ab25-bab4211230bc\",\n \"Message\": \"Transaction returned\"\n}\n\nCallback for the payment request approval by the sender(i.e., the reference ID from whom it is requested)
\n{\n \"Date\": \"2022-01-12T13:12:41\",\n \"Data\": {\n \"CreatedDate\": \"2022-01-12T13:12:24.674Z\",\n \"TransactionNumber\": \"FV000005827\",\n \"Type\": \"Payment Request - FV Net\"\n },\n \"Event\": \"MEMBER_AUTHORIZED\",\n \"Message\": \"Payment request authorized by the user\"\n }\n\n{\n \"Date\": \"2022-01-13T04:41:53\",\n \"Data\": {\n \"CreatedDate\": \"2023-02-17T11:09:31.609Z\",\n \"TransactionNumber\": \"FV000014212\",\n \"Type\": \"Deposit - Domestic Wire\",\n \"Amount\": \"3999600.00\",\n \"From\": \"FALCONX LIMITED\",\n \"To\": \"Raj Biz Co - Raj Biz\",\n \"Currency\": \"USD\",\n \"Description\": \"DEPOSIT REFERENCE: 7801000107\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"FALCONX LIMITED\"\n },\n {\n \"label\": \"Originator Account Number\",\n \"value\": \"5090013995\"\n },\n {\n \"label\": \"Originator Address\",\n \"value\": \"LEVEL G, OFFICE 1/1191, QUANTUM HOU SE 75 ABATE RIGORD STREET\"\n },\n {\n \"label\": \"IMAD\",\n \"value\": \"20220913MMQFMPUR001023\"\n },\n {\n \"label\": \"OMAD\",\n \"value\": \"20220913GMQFMP0101552709131240\"\n },\n {\n \"label\": \"Import Key\",\n \"value\": \"2ac616d6-9a7c-4bae-8aeb-ea6d494f6fdb\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_RECEIVED\",\n \"Message\": \"Deposit created\"\n}\n\n{\n \"Date\": \"2022-01-13T04:41:53\",\n \"Data\": {\n \"CreatedDate\": \"2023-02-17T11:14:25.634Z\",\n \"TransactionNumber\": \"FV000014214\",\n \"Type\": \"Deposit - Domestic Wire\",\n \"Amount\": \"400000\",\n \"From\": \"FALCONX LIMITED\",\n \"To\": \"Raj Biz Co - Raj Biz\",\n \"Currency\": \"USD\",\n \"Description\": \"780008000006\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"FALCONX LIMITED\"\n },\n {\n \"label\": \"Originator Account Number\",\n \"value\": \"5090013995\"\n },\n {\n \"label\": \"Originator Address\",\n \"value\": \"LEVEL G, OFFICE 1/1191, QUANTUM HOU SE 75 ABATE RIGORD STREET\"\n },\n {\n \"label\": \"IMAD\",\n \"value\": \"20220913MMQFMPUR001023\"\n },\n {\n \"label\": \"OMAD\",\n \"value\": \"20220913GMQFMP0101552709131240\"\n },\n {\n \"label\": \"Import Key\",\n \"value\": \"2ac616d6-9a7c-4bae-8aeb-ea6d494f6fdb\"\n },\n {\n \"label\": \"Virtual Account\",\n \"value\": \"780008000006\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_RECEIVED\",\n \"Message\": \"Deposit created\"\n}\n\n{\n \"Date\": \"2022-03-13T06:53:49\",\n \"Data\": {\n \"CreatedDate\": \"2023-03-20T14:45:38.243Z\",\n \"TransactionNumber\": \"FV000015259\",\n \"Type\": \"CREDIT – ACH DOMESTIC TRANSACTION\",\n \"Amount\": \"100.00\",\n \"From\": \"Test Sender\",\n \"To\": \"Rishav_Business - Rishav\",\n \"Currency\": \"USD\",\n \"Description\": \"Depositing USD\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"Test Sender\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_AUTHORIZED\",\n \"Message\": \"Deposit authorized\"\n}\n\n{\n \"Date\": \"2022-02-13T06:53:49\",\n \"Data\": {\n \"CreatedDate\": \"2023-02-20T14:45:38.243Z\",\n \"TransactionNumber\": \"FV000015260\",\n \"Type\": \"CREDIT – ACH DOMESTIC TRANSACTION\",\n \"Amount\": \"100.00\",\n \"From\": \"Test Sender\",\n \"To\": \"Rishav_Business - Rishav\",\n \"Currency\": \"USD\",\n \"Description\": \"Depositing USD\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"Test Sender\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_DENIED\",\n \"Message\": \"Deposit authorized\"\n}\n\n{\n \"Date\": \"2022-01-13T06:53:49\",\n \"Data\": {\n \"CreatedDate\": \"2023-01-20T14:45:38.243Z\",\n \"TransactionNumber\": \"FV000015262\",\n \"Type\": \"CREDIT – ACH DOMESTIC TRANSACTION\",\n \"Amount\": \"100.00\",\n \"From\": \"Test Sender\",\n \"To\": \"Rishav_Business - Rishav\",\n \"Currency\": \"USD\",\n \"Description\": \"Depositing USD\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"Test Sender\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_CANCELLED\",\n \"Message\": \"Deposit cancelled\"\n}\n\n{\n \"Date\": \"2022-01-02T06:53:49\",\n \"Data\": {\n \"CreatedDate\": \"2023-01-01T14:45:38.243Z\",\n \"TransactionNumber\": \"FV000015265\",\n \"Type\": \"CREDIT – ACH DOMESTIC TRANSACTION\",\n \"Amount\": \"100.00\",\n \"From\": \"Test Sender\",\n \"To\": \"Rishav_Business - Rishav\",\n \"Currency\": \"USD\",\n \"Description\": \"Depositing USD\",\n \"AdditionalData\": [\n {\n \"label\": \"Originator Name\",\n \"value\": \"Test Sender\"\n }\n ]\n },\n \"Event\": \"DEPOSIT_RETURNED\",\n \"Message\": \"Deposit returned\"\n}\n\nFVBank API Suite Transition to v2 with Enhanced Beneficiary Fields and Payments Endpoints Modifications
\n1. Payment Endpoints
\n1.1 Send Bank Payment [V2]: The Payment endpoint will now generate an error message if the new beneficiary fields are missing in the existing beneficiary records. Please keep in mind that this error will only be triggered for International Wire payment type.
\n![](\"https://lh7-us.googleusercontent.com/pY4JMlBIzM03hURMhyUXpznCaQZvPUGTOAs5XBusmt1coeRTfRS1HM8zag3N7GWSM65C7PRayf-BKHPrvV4NhCl-U_wxx8doz9KCKe1thuGwHo2ILs9Blo4eeZGejGV73zN3CyHbiHxzAXnUA2fiyBg\")
\n\n1.2 Preview - Send Bank Payment [V2]: Changes similar to Send Bank Payment[V2].
\n2. Beneficiary Endpoints
\n2.1 Create Beneficiary [V2]: With the 'Create Beneficiary [V2]' endpoint, you can now send the newly added fields for the beneficiary along with your request.
\n2.2 Get Required Fields [V2]: The 4 new beneficiary fields will be provided in the response of this endpoint on the basis of type of the beneficiary.
\n-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment [V2] (As described above)
\n1.2 Preview Bank Payment [V2] (As described above)
\n2. Beneficiary Endpoints
\n2.1 Get Required Fields [V2]: The 'Get Required Fields' endpoint will now include the newly added fields as part of its response.
\n2.2 Get Beneficiary Details [V2]: New fields will be reflected in this endpoint response.
\n2.3 Create Beneficiary [V2] (As described above)
\nTransition from v1 to v2: We are phasing out all v1 endpoints as part of our move to the enhanced v2 API suite. While v1 endpoints will be deprecated, their functionalities are preserved and transitioned to corresponding v2 endpoints. For users with beneficiaries or payment instruments initially created using v1 endpoints, we recommend consulting our migration guide available in our API documentation. This guide provides detailed instructions for seamlessly transitioning these elements to the v2 framework.
\n- None
\nRefer to documenation
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"4f5ae061-d7c4-46bd-84b0-018b4818b98a"},{"name":"Enabling SEPA payments","item":[],"id":"d786d9a1-ef59-45e8-bf44-b479b3e61aa2","description":"The API suite will not Introduce SEPA (Single Euro Payments Area) payments as a new feature. This service which has been available on the portal is now made available through an API (Application Programming Interface), offering businesses a convenient and efficient way to process SEPA payments. SEPA payments enable simplified euro transactions across participating European countries, making it easier for businesses to conduct cross-border transactions within the Eurozone.
\nBreaking Changes
\n-None
\n1. Preview - Send SEPA Payment: The \"Payment Preview\" endpoint allows users to provide SEPA transaction details so that they can preview the fees involved, the expected exchange rate, and a unique quote ID. Please plan on submitting the transaction within an hour of obtaining the quote. This gives FV Bank enough time to review the transaction, authorize it and to execute it.
\nRequest Body:
\nResponse Body:
\n2. Send Cross Border Payment: The \"Send SEPA Payments\" endpoint allows for the seamless initiation of SEPA transactions while ensuring compliance with SEPA regulations. Users can specify payment details, including purpose, currency, and amount. Optionally, a QuoteId may be provided for the transaction. If left empty, a new quote will be generated concurrently. To obtain a FileId for the Supporting Document, users can utilize the Upload File endpoint to retrieve the generated ID.
\nRequest Body:
\nResponse Body:
\n1. Upload File: The \"Upload File\" endpoint enables users to upload files and receive a unique ID in response. This ID can be subsequently used in any field requiring image or file references within the scope of the APIs. Please note that a File reference can be used only once in a transaction. The same reference ID cannot be used in another transaction.
\nRequest Body:
\nResponse Body:
\n2. Get File: The \"Get File\" endpoint accepts a file ID in the URL parameter and responds by providing the corresponding file in the response body. The content type response header is structured according to the format of the uploaded file, ensuring seamless access and retrieval of specific files based on their unique IDs.
\nRequest URL:
\n3. Get File Details: The \"Get File Details\" endpoint serves to retrieve essential metadata about a specific file. It returns key information including the file name, file type, and a unique file ID.
\nRequest URL:
\nResponse Body:
\n-None
\n-None
\n-None
\n- None
\nPlease refer to documenation
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us on the slack and for Operational support on support@fvbank.us.
\n","_postman_id":"d786d9a1-ef59-45e8-bf44-b479b3e61aa2"},{"name":"Introducing \"Supporting Document\" in USD Payments Endpoint","item":[],"id":"567427d6-4379-42cb-9950-02c8f518b893","description":"As part of our ongoing efforts to enhance the security and efficiency of the FVBanks API Suite, we are introducing some updates that involve the addition of a new mandatory field, designed to further authenticate and validate transactions. This document outlines the changes and provides guidance on how developers can adapt to these enhancements.
\nA new field, titled Supporting Document File ID, is being added to the USD Payments endpoint. This field is mandatory for all transaction requests.The new field is of type File ID, requiring a valid file ID or multiple file IDs. File ID is obtained from the Files endpoint within the FVBanks API Suite.
\nThe addition is aimed at enhancing transaction security and efficiency by requiring a supporting document for transaction validation.
\nBreaking Changes
\n1. Payment Endpoints
\n1.1 Send Bank Payment [V2]: The Payment endpoint will now generate an error message if the
\"Supporting_Document\" field is missing in the request body.
1.2 Preview - Send Bank Payment [V2]: Changes similar to Send Bank Payment[V2].
\n-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment [V2] (As described above)
\n1.2 Preview Bank Payment [V2] (As described above)
\n-None
\n-None
\n- None
\nThe workflow to integrate the new field is straightforward yet critical for the enhanced security mechanism. Here's a quick rundown:
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"567427d6-4379-42cb-9950-02c8f518b893"},{"name":"Adding Optional Beneficiary IBAN and State(Address) fields to payment instrument, beneficiary and payments endpoints.","item":[{"name":"Beneficiary IBAN","item":[],"id":"2cc23b71-2a2a-4648-99c6-c7534afe3bbe","description":"We are introducing an optional field, Beneficiary_IBAN, to enhance the creation and management of payment instruments, specifically for international wire transfers. This field represents the IBAN (International Bank Account Number) of the beneficiary's bank account, providing an additional layer of detail to streamline international transactions.
Beneficiary_IBAN during the \"create payment instrument\" step. This is particularly relevant for setting up new international wires, where specifying the IBAN can facilitate faster and more accurate processing of transactions.Beneficiary_IBAN at the \"create payment\" endpoint via Additional_Info attribute in request body for transactions involving already established payment instruments. Upon successful validation of the provided IBAN against the available SWIFT code associated with the payment instrument, the system will automatically update the instrument to include the bank accounts IBAN.Beneficiary_IBANBeneficiary_IBAN field is optional, providing it during the setup of international wire payment instruments is highly recommended for enhanced transaction accuracy and efficiency.-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment [V2] (As described above)
\n1.2 Preview Bank Payment [V2] (As described above)
\n2. Payment instrument Endpoint
\n2.1 Get Required Fields: Beneficiary_IBAN would now come up in the response body of this endpoint.
2.2 Create Payment Instrument: Beneficiary_IBAN if present in the request body will be picked up and after successfull validation stored in the payment instrument
Endpoint URL : {{baseURL}}/v2/resource/validate/:routingNumberType/:routingNumber
-None
\n- None
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"2cc23b71-2a2a-4648-99c6-c7534afe3bbe"},{"name":"Beneficiary State","item":[],"id":"7ef34fb6-e1e9-4ff7-9f50-858912742676","description":"We are introducing an optional field, Beneficiary_State, to enhance the creation and management of beneficiary. This field represents the state/region of the business/individual entity for which the benficiary is created.
Beneficiary_State during the \"create benficiary\" step.Beneficiary_State at the \"create payment\" endpoint via Additional_Info attribute in request body for transactions involving already established beneficiary. The system will automatically update the associated benficiary to include the beneficiary state.Beneficiary_StateBeneficiary_State field is optional, providing it during the setup of benficiary is highly recommended for enhanced transaction accuracy and efficiency.-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment [V2] (As described above)
\n1.2 Preview Bank Payment [V2] (As described above)
\n2. Beneficiary Endpoint
\n2.1 Get Required Fields: Beneficiary_State would now come up in the response body of this endpoint.
2.2 Create Beneficiary: Beneficiary_State if present in the request body will be picked up and after successfull validation stored in the beneficiary info.
-None
\n-None
\n- None
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"7ef34fb6-e1e9-4ff7-9f50-858912742676"}],"id":"95b64dc6-e03b-4966-ad8f-9a8b5b4c7d89","_postman_id":"95b64dc6-e03b-4966-ad8f-9a8b5b4c7d89","description":""},{"name":"Marking Some Beneficiary Fields as Optional","item":[],"id":"fd74db0f-1fdd-4674-9b98-8275c5a9d042","description":"The new benficiary fields introduced by the \"FVBank API Suite Transition to v2 with Enhanced Beneficiary Fields and Payments Endpoints Modifications\" release are being marked as NON-MANDATORY namely Date of Birth (DOB), Beneficiary Relationship, Beneficiary ID Number, and Beneficiary ID Type. They will now be optional in Beneficiary and Payments endpoints.
\nPlease refer to \"FVBank API Suite Transition to v2 with Enhanced Beneficiary Fields and Payments Endpoints Modifications\" release in API change log for more details.
\n","_postman_id":"fd74db0f-1fdd-4674-9b98-8275c5a9d042"},{"name":"Making Beneficiary State(Address) fields mandatory in beneficiary and payment endpoints.","item":[],"id":"fe492c48-802e-4863-aaae-791f4d2ea0ad","description":"The new benficiary field introduced by the \"Adding Optional Beneficiary IBAN and State(Address) fields to payment instrument, beneficiary and payments endpoints.\" release on 25th April 2024 is being marked as MANDATORY namely Beneficiary_State in Sandbox environment. It will now be mandatory in Beneficiary and Payments endpoints.
\nPlease refer to \"Adding Optional Beneficiary IBAN and State(Address) fields to payment instrument, beneficiary and payments endpoints\" release in API change log for more details.
\n","_postman_id":"fe492c48-802e-4863-aaae-791f4d2ea0ad"},{"name":"New API Change: Mandatory 2FA for Withdrawals","item":[],"id":"1ed12a5b-95c4-4516-b467-b7bcd164e47b","description":"All types of withdrawals, including International, Domestic, ACH, Wire, and FVnet, will now require users to have Two-Factor Authentication (2FA) enabled in the web portal. Without this security check, withdrawal transactions will not be processed. Please ensure that 2FA is activated to avoid any disruptions in your withdrawal activities.
\n-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment
\n1.2 Preview Bank Payment
\n2. Custody Endpoints
\n2.1 Preview - Custody Withdraw
\n2.2 Transfer - Custody Withdraw
\n3. Transfer Endpoints [FVnet Payments]
\n3.1 Send Payment to Referred Account
\n3.2 Transfer - Custody Withdraw
\n-None
\n- None
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"1ed12a5b-95c4-4516-b467-b7bcd164e47b"}],"id":"2a3c429b-43e7-4439-83e6-c9c60f065753","description":"","_postman_id":"2a3c429b-43e7-4439-83e6-c9c60f065753"},{"name":"Upcoming Changes","item":[{"name":"Taxform and Custody Agreements(Custody User) mandatory for Withdrawals","item":[],"id":"f994ade1-81f8-4cbc-8c48-80920729f474","description":"All types of withdrawals, including International, Domestic, ACH, Wire, and FVnet, will now require users to have submitted the tax form and accepted custody agreements(for Custody users only) in the web portal. Without this security check, withdrawal transactions will not be processed.
\n-None
\n1. Payments Endpoints
\n1.1 Send Bank Payment
\n1.2 Preview Bank Payment
\n2. Custody Endpoints
\n2.1 Preview - Custody Withdraw
\n2.2 Transfer - Custody Withdraw
\n3. Transfer Endpoints [FVnet Payments]
\n3.1 Send Payment to Referred Account
\n3.2 Transfer - Custody Withdraw
\n-None
\n- None
\nPlease refer to the official API documentation for the API schema and response models. For technical queries contact us in the slack channel and please refer to support@fvbank.us for operational support.
\n","_postman_id":"f994ade1-81f8-4cbc-8c48-80920729f474"}],"id":"263db210-c916-4b20-afd9-cce54bda44fd","description":"","_postman_id":"263db210-c916-4b20-afd9-cce54bda44fd"}]}