{"info":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","description":"

$\"logo\"$

Intro

Banq's Open API helps to integrate with Banq functionality related to payment creation and payments/transaction tracking. Using Open API one can create requests to get paid, browse banqs within the system, retrieve payment transactions, and setup webhooks to get notified about changes.

Guides

Please take a look at the guides in our developer center for integration information.

Authentication

Authentication is performed via the Auth0 platform based on API client_id and username/password. Integrators are represented as an M2M Application that that interacts with the Banq API on behalf of the Banq user. Client credentials flow should be used to obtain the access token and use it in the Authorization header with the Bearer prefix to access Banq API.

You need to POST to Auth0 endpoint /oauth/token following values (see example in Authentication folder:

client_id identifier of the M2M Application
username username for the M2M Application
password password for the M2M Application
audience: https://banq.com/open/api/
grant_type: password

All Open API operations are performed on this user's behalf.

Error Codes

200 - the request was performed successfully and the relevant response is returned.
201 - the entity was created successfully and is returned in the response. This entity is accessible at the link sent in the Location response header.
400 - the request was malformed or some business rules were not satisfied. Returns error message.
401 - there were problems with the access token or it is missing.
403 - the operation is forbidden for the current user.
404 - the entity was not found in the system.
422 - due to validation errors or external reasons, the request cannot be processed.

Transaction fail reasons

None - default transaction fail reason.
ProcessingFailed - processing failed.
LimitsExceeded - limits exceeded.
FingerprintBlacklisted - finger print blacklisted.
BanqError - the banq error.
PrimeTrustError - the prime trust error.
InsufficientBalance - exception is caused by insufficient balance.
CustodialAccountContactIsNotApproved - the custodial account contact is not approved.
ExternalAccountIsDeactivated - the external account is deactivated.
PlaidRequiresReAuthentication - the plaid requires re authentication.
AccountIsFrozen - the account is frozen.
Reversed - transaction is reversed.
Cancelled - transaction is cancelled.

Pagination

Some endpoints return data in pages. They accept the following query parameters that control pagination:

page - one-based number of the page;
pageSize - the number of items that will be returned.

The response contains meta property that holds an object with the following data:

resourceCount - total number of filtered items in the system;
pageCount - total number of pages calculated using query parameters page and pageSize.\nThe response also contains property data with a collection of entities.

Idempotent headers

The API allows performing idempotent POST requests. To enable this feature one needs to add X-Idempotent-Id header with a unique identifier (GUID). All subsequent requests with this header will return the same response as the first one.

Webhooks

Whenever changes to payment or transaction object are made, a webhook is sent to the URL set in POST/PUT api/v1/account-spaces/{accountSpaceId}/webhook-config.
The webhook structure looks like this:

{\n  \"accountSpaceId\": 1, // identifier of the account space related to the operation that triggered the webhook\n  \"action\": \"Created\", // a string representation of what happened to the resource\n  \"id\": \"c88d829b-c2c1-4c78-9b07-e7667ee399ff\", // unique identifier of this webhook\n  \"resourceId\": \"9bf48226-79c3-43d2-9be5-264bfef4660d\", // identifier of the entity that has changed\n  \"resourceType\": \"Transaction\", // the type of the entity\n  \"createdAtUtc\": \"2021-01-11T12:12:12.5431424+00:00\" // time of webhook creation\n}\n

For now, we send webhooks for resourceType:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`\"resourceType\"`	`\"action\"`
`\"Payment\"`	`\"Created\"`, `\"Completed\"`, `\"Accepted\"`, `\"Declined\"`, `\"OnHold\"`, `\"Canceled\"`, `\"Expired\"`, `\"Resumed\"`, `\"OccurrenceCanceled\"`
`\"Transaction\"`	`\"Created\"`, `\"Failed\"`, `\"Updated\"`

Payments

Our notification system sends webhooks whenever there are some changes in payments or transactions. For example, let us consider a typical Open API flow:

Integrator creates a one time request to get paid via api/v1/payments/get-paid-direct: a payment entity is created in Banq system; webhook with \"resourceType\": \"Payment\" and \"action\": \"Created\" is scheduled.
A Banq user accepts this request via mobile app:
- a payment status changes to \"Accepted\"; webhook with \"resourceType\": \"Payment\" and \"action\": \"Accepted\" is scheduled.
- a transaction is created:
  - if it is successfull, a webhook with \"resourceType\": \"Transaction\" and \"action\": \"Created\" is scheduled.
  - if it fails, a webhook with \"resourceType\": \"Transaction\" and \"action\": \"Failed\" is scheduled.
  \n
- a payment status changes to \"Completed\"; a webhook with \"resourceType\": \"Payment\" and \"action\": \"Completed\" is scheduled.
\n

Webhook message authentication

To enable integrity and authenticity verification of a HTTP webhook message, we append a X-Banq-Webhook-Hmac header with base 64 encoded HMAC value. This HMAC value is calculated over the webhook request body using SharedSecret. SharedSecret is set in the request body to POST api/v1/account-spaces/{accountSpaceId}/webhook-config endpoint. HMAC value is calculated with SHA256 hashing algorithm.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Intro","slug":"intro"},{"content":"Guides","slug":"guides"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Transaction fail reasons","slug":"transaction-fail-reasons"},{"content":"Pagination","slug":"pagination"},{"content":"Idempotent headers","slug":"idempotent-headers"},{"content":"Webhooks","slug":"webhooks"},{"content":"Payments","slug":"payments"},{"content":"Webhook message authentication","slug":"webhook-message-authentication"}],"owner":"11378575","collectionId":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","publishedId":"TVzSjHF8","public":true,"customColor":{"top-bar":"303030","right-sidebar":"303030","highlight":"7622A9"},"publishDate":"2021-03-25T18:42:35.000Z"},"item":[{"name":"Guided Walkthrough","item":[{"name":"Generate access token","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"token\", jsonData.access_token);"],"type":"text/javascript","id":"9229bab6-35ef-478a-b054-b2328c5a28d2"}}],"id":"42a4527d-6ddf-476d-8223-76bead9a0a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\":\"{{client_id}}\",\n \"username\":\"{{username}}\",\n \"password\":\"{{password}}\",\n \"audience\":\"https://banq.com/open/api/\",\n \"grant_type\":\"password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{authTenat}}.auth0.com/oauth/token","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["oauth","token"],"host":["{{authTenat}}","auth0","com"],"query":[],"variable":[]}},"response":[{"id":"0e839dc6-2901-484b-aaa1-810a50c5ac41","name":"Generate access token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"audience\": \"https://banq.com/open/api/\",\n \"grant_type\": \"client_credentials\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{authTenat}}.auth0.com/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Dec 2020 20:51:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"603385c229cb2deb-KBP"},{"key":"Cache-Control","value":"no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"071411ed5a00002deb490d3000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"ot-baggage-auth0-request-id","value":"603385c229cb2deb"},{"key":"ot-tracer-sampled","value":"true"},{"key":"ot-tracer-spanid","value":"44ac0ca6221c8129"},{"key":"ot-tracer-traceid","value":"056723b774cb0821"},{"key":"Pragma","value":"no-cache"},{"key":"X-Auth0-RequestId","value":"a5f2819f4eb370885359"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"1000000"},{"key":"X-RateLimit-Remaining","value":"999999"},{"key":"X-RateLimit-Reset","value":"1608238291"},{"key":"Server","value":"cloudflare"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5URXhSRUZETmpkRFF6UkZRelZEUmtFM1JqUXlPVFl4TlRneE1VUXdNVGM0TlRjeE1UTTBPUSJ9.eyJpc3MiOiJodHRwczovL2Rldi03N3V0a2hicC5hdXRoMC5jb20vIiwic3ViIjoiY0JiMGJoV2ZlTmp4QnBwWGlRNWd1VlN0VjRhYU9mRGtAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYmFucS5jb20vb3Blbi9hcGkvIiwiaWF0IjoxNjA4MjM4MjkwLCJleHAiOjE2MDgzMjQ2OTAsImF6cCI6ImNCYjBiaFdmZU5qeEJwcFhpUTVndVZTdFY0YWFPZkRrIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.o7uwLe7lQRIvx1EpNYSB6mPzI7xb-zWiKPJEeXek_rZrOZDHcyeer9DSjd35dZmvuvaWrWuHLYlT7dOwdEXzim3yL6xYh3Xf1zy1dwrhCJnsy0krnH-xZ3e1EEFiZSB6uUKdyhmkboLP44w_mL4UxxeSvdBX5AEIHaAG7lhITKulU1zYSwWsHsyr5dxStgKzO9vmH63EuQJx8u3nwr8bZqzRebny5h0PMwozwyosoCAlR8xvATkFCmx0KVLkz7QmWZRszdEA7o7PDy6hX1X1zO3EZh2FOzUPG94NLGyVb8vX7sTtmy255J71WDT4RgFsLxlKvkXOPZB_lwd68hWHXQ\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"42a4527d-6ddf-476d-8223-76bead9a0a5a"},{"name":"Setup Webhook-config on accountSpace","id":"d62c0dea-23d9-4fb2-86ea-7f183a09548f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"string\",\n \"enabled\": true,\n \"retryCount\": 10,\n \"sharedSecret\": \"string\",\n \"webHookTypes\": [\n \"payment\", \"transaction\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config","urlObject":{"path":["v1","account-spaces","{{accountSpaceId}}","webhook-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"10056250-8f8b-4842-9456-7abed23b83c7","name":"Setup Webhook-config on accountSpace","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://webhook.site/4cc18bb9-98f4-41a4-894a-6c072029470e\",\n \"enabled\": true,\n \"retryCount\": 5,\n\n \"webHookTypes\": [\n \"payment\", \"transaction\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/14809/webhook-config"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Location","value":"http://aks-banq-stage-01.eastus.cloudapp.azure.com/api/v1/accounts/14809/webhook-config"},{"key":"Request-Context","value":"appId=cid-v1:237bf36d-e4ca-49e1-8a9b-1a7760711338"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"},{"key":"X-Cache","value":"CONFIG_NOCACHE"},{"key":"X-Azure-Ref","value":"0eswCYQAAAAB1WOjG4HQ0Ro9cTiJf75kVRE5BRURHRTA0MDkAODA1YzY5ZDEtNTg3YS00ZjA5LTk3NWUtNjdhYjAxOGQxNjA2"},{"key":"Date","value":"Thu, 29 Jul 2021 15:42:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accountSpaceId\": 14809,\n \"id\": 137,\n \"url\": \"https://webhook.site/4cc18bb9-98f4-41a4-894a-6c072029470e\",\n \"enabled\": true,\n \"guid\": \"8ba874b4-44c6-43d5-ad8c-69ed8699a11a\",\n \"createdById\": 13882,\n \"updatedById\": 13882,\n \"createdAtUtc\": \"2021-07-29T15:42:50.4035371+00:00\",\n \"updatedAtUtc\": \"2021-07-29T15:42:50.4035371+00:00\",\n \"retryCount\": 5,\n \"sharedSecret\": \"3c5c22c1-e66e-4b44-acd0-774cc3795e95\",\n \"webHookTypes\": [\n \"payment\",\n \"transaction\"\n ],\n \"type\": \"webhook-config\"\n }\n}"}],"_postman_id":"d62c0dea-23d9-4fb2-86ea-7f183a09548f"},{"name":"Create Get Paid payment link","id":"dd5a9f93-3935-4aec-a613-5a1167e852a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Idempotent-Id","value":"468e5c6a-a2af-408d-b597-7d55a632a70f","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"destination\": {\r\n \"banqGuid\": \"{{banqGuid}}\"\r\n },\r\n \"funds\": 1,\r\n \"frequency\": \"once\",\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"comment\": \"order description\",\r\n \"externalOrderCode\": \"# form other system\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/payments/get-paid-link","description":"

Creates the get paid link..

\n","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","payments","get-paid-qr"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0e7abb0f-4643-4a9d-a8f5-373c31a0fb14","name":"Create Get Paid payment QR","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true},{"key":"X-Idempotent-Id","type":"text","value":"1cc87f3b-081d-4e63-9810-15710cabf36d","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"destination\": {\r\n \"banqGuid\": \"{{banqGuid}}\"\r\n },\r\n \"funds\": 1,\r\n \"frequency\": \"once\",\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"comment\": \"order description\",\r\n \"externalOrderCode\": \"# form other system\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/payments/get-paid-qr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 11:30:40 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"size\": \"small\",\n \"base64Content\": \"iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAABHNCSVQICAgIfAhkiAAAA7pJREFUeJzt3NtOHEEMRdEJyv//MnlARK0G97js4+qBs9djVJeGWC7q+ngAAAAAAAAAAIDf7E+hzrv8Kz5cfctqn8e23hP/nm3rKGo3647f4xdvQx+BH4IAMEcAmPsraKMy/n2KxsGr8TEzvkflr0TtRn1k2j3/HN1vzPSxhAxgjgAwpxgCjjLpKJPulFPCqPxVH5npYncaGFH9DlPIAOYIAHPqIUAlOwvI1M+s5J3Lrab9qeFgHBnAHAFg7lWHgLNMelZu2lQWeTr93YYMYI4AMKceAlQpL7tIc5RZQKmk5x17AatlZMgA5ggAc4ohYOJoU3aRJrO9mj0StlpHuRA0dTzsKTKAOQLA3KsuVFT2ArppVJXSWQjCz0EAmFOkqO7Fi07dzpp9t91MH+d2MuVWy7T+D8kA5ggAcwSAucpKYHeDo7s/v3qZJNt3dBlk9TuuqC6AZFc0nyIDmCMAzKlXqlYvNVQubUT9daeEndPGlZ9DNX1e6fMLMoA5AsCcYu96x355hvIpmKn0vNrfIygTtbOMDGCOADA3eSp4Na1VjmutqvxVnvmO7Pd1hsuRoYgMYI4AMKeeBWTqdO/wdRZ/poYZ5TG1rbMnMoA5AsDc5JGw1bpHlUeiphakOgsw3QsuI4s/R2QAcwSAOcWJoE65yl/PO/YSov4qT9tG5VQLO5wIQh0BYG7y7trUXkDnO7K63xu1o1pgkiEDmCMAzBEA5iaPhK32uXvql/07Y+qyZucZmug7lpEBzBEA5tSbQVHbU5szyqFh90ngTt/cDYQGAWDujreCu6dpo7ZWVa6mR+68G8gsAHUEgLldC0FTV8JX6ytnELtfH8sOg8wCkEcAmFM/bT7x3u5VH5X6UTuqtfbsQ1SdmQ2ngqFBAJi7ezt46o3d7paz6p3j7h3H8ZkGGcAcAWBu8nr41Cxgte+o/I73+KYWza4wBCCPADCnXgjK9KM83Dh1xbpzgmn3CaJsnW+RAcwRAOYIAHPjlw+Lui+RRXWn/n7Jlp84MseRMNQRAOYmn4hZFb2Le+6zs5o2NdWMyivbHUEGMEcAmFNcDJl4vmXqHd/Kca3d9wSPpobb/8gA5ggAc+q7gTtOtE4MB2dTwwGvhOG1EADm1EPADsoHKCOZ1Nt52Clb/5Eow91A1BEA5l51CLhKY6vpuVJmx9Pxmb7HF6TIAOYIAHN3PBKVMXUiKCtKt7tfGGEvALMIAHOKIWAiTVVe1lCm5Ikt7rPdJ5u+RQYwRwCYIwAAAAAAAAAAAAB+sX+O5/PrVPyicwAAAABJRU5ErkJggg==\",\n \"type\": \"get-paid-qr\"\n },\n {\n \"size\": \"medium\",\n \"base64Content\": \"iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAABHNCSVQICAgIfAhkiAAABeVJREFUeJzt3VuSGzkMBMBZx9z/yusD2K1dctAAuyvz2xKtx1QwABH8+gIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADK/dO0zr9N61RZfV86Xt/V/+nT2juPWVX1XnV8F9/+PVz26+4FgHMJAAgmACCYAIBgAgCCfQ+v39WF+JudivDqYz69vqpqeOV7uNM1WH0dlf/fyo7C076LJewAIJgAgGACAIIJAAgmACDYdBfgyuRv1Sufq6O6u7NGZadhdf3JswA7Tv0ulrADgGACAIIJAAgmACCYAIBgAgCCndoGPFXlYaCqtXfWWH2uyoNTlaPN+CE7AAgmACCYAIBgAgCCCQAIpgtQo7J6XnngqKp63tHN2HmM7sAP2QFAMAEAwQQABBMAEEwAQLBTuwCnVnc7Lu2oHEHVUT1/y8UgV079LpawA4BgAgCCCQAIJgAgmACAYNNdgLFrkTdNTrmpXKPjdTxtItDTvosl7AAgmACAYAIAggkACCYAIJgAgGCvPuhwg46LQSbbUU9r0fn+/pAdAAQTABBMAEAwAQDBBAAEm66i7lR3O6rklRd9rK6xavL9qFR5icrkc+18d8f+Du0AIJgAgGACAIIJAAgmACBY10iwyQscTlz7k8mq89W/n67QV63doWN8Whk7AAgmACCYAIBgAgCCCQAINn0W4ErHb+4rK9s7Jq/uvjL5+jo+j8oKfQddAOA+AgCCCQAIJgAgmACAYAIAgnW1AU+8j/5UHe2zKx2fx6SOcV3T7eUldgAQTABAMAEAwQQABBMAEKxrJNiq6WptVadhuhJe9Z7sVKkruzVVh5o6PvPpS22W2AFAMAEAwQQABBMAEEwAQLBTzwJMrzHZaVj1lm5G5edU6dVnT+wAIJgAgGACAIIJAAgmACDYdMVyspI6fRHF6hqVv6F3+cj/f8zq2p9M/739wQ4AggkACCYAIJgAgGACAIIJAAjWNRKs8tBG1XN1HD45ru3zHzralpVrrz7XqeO6xtrhdgAQTABAMAEAwQQABBMAEOxpVeqvr2ddDNLhaeO6KseOPW2E2XHsACCYAIBgAgCCCQAIJgAg2KkXg1RWcf3m/08dl6hc6RjXdeXUS1TGvj92ABBMAEAwAQDBBAAEEwAQbLp6PXlxxqlV50lPm6Rz5S1nF0wEAu4jACCYAIBgAgCCCQAIJgAgWNfFIKsm75D/9JgrHYdoKlW+vx0t06q1Kw8DVXIYCOgnACCYAIBgAgCCCQAI9qaRYCeOaJoeD+Uik/t0jFVzGAi4jwCAYAIAggkACCYAINh0F+DKzu/0Jyu/Vzoq+jtO7Jh8UtVFmj6zcdwYODsACCYAIJgAgGACAIIJAAg23QWYvB781PMGT7u6u0pH56fyopbp96SEHQAEEwAQTABAMAEAwQQABBMAEOzUNmDXc1WtvaOj7TTZ1rsyOfLsae+hNiBwHwEAwQQABBMAEEwAQLDpLkClt4+5Wn2eTyav1Z4ey1Vl8nBWGTsACCYAIJgAgGACAIIJAAh23EUFh+s4h9BxiUqlE8e6veW8we3sACCYAIBgAgCCCQAIJgAg2HfTOif+lvuTq6psZTW649KOJ51p2Fmj8nkiO2J2ABBMAEAwAQDBBAAEEwAQTABAsK424JXJ1stOa6njYMiqnVZjZTvzxMtHrpzYmhxlBwDBBAAEEwAQTABAMAEAwaa7AFcmr+Gu9JZxXTuHaCa7A9Pdl8ewA4BgAgCCCQAIJgAgmACAYKd2Ad6icgRVx9ixK5UV78rRZh2XqDztKvUldgAQTABAMAEAwQQABBMAEEwXYM1qVbajet7xXJVXXldOYuqwWqGfPv+xxA4AggkACCYAIJgAgGACAIIJAAh2ahvw1HFLHYc2Kg+4VNlpbY0dcPmgsg13XEtvhx0ABBMAEEwAQDABAMEEAASb7gI8rZLaMdLpxCr5dFemY7RZVfelcgzc7ewAIJgAgGACAIIJAAgmAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACg0m8DzPS3YlEklAAAAABJRU5ErkJggg==\",\n \"type\": \"get-paid-qr\"\n },\n {\n \"size\": \"large\",\n \"base64Content\": \"iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAYAAAD0eNT6AAAABHNCSVQICAgIfAhkiAAAC31JREFUeJzt3UFu5MoRRdGy0fvfsj1peGTgi0Qr9TrvORsQi2SVLnIQ8fkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADw//3rpy/gD/rPT1/AxU68J7c8vzf36ulnP/E3Tlh9r275XVx85re44h35909fAABwngAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBv376An7QFbOcXzoxI/zE33j6DFfnwi++iyf2DZx4Hov39vM5s//hqdV7dUJyb4ITAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAUHkZ0BuLCyNWF3icuK7F5/HG4uKkE39jdSnV6ndq0eJ30PP7IicAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAgSAAAQJBdAHyXW+bbP7U6e/7pdb25psXZ/ic+x+J7CP/ICQAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIMgyIFasLp+5ZVHPCYvXtbig6PPZvFfEOAEAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAguwCeMb87q87ca8W5/SfcMvs+ROfY/Fzfz72PzDACQAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIKi8DGhxyctNTiw7WVyosvo5/I2tv7HIb2KMEwAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAg6JYZ1uw5MVf8xPtbnY9uhv7XvXlHbvns/MWcAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAgsoLKU4s8LhlkcyJxTAnrL7vi/fqjdX7+9TiIqvFa/p8Nq/LcqYvcgIAAEECAACCBAAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABP366Qv4g57Of16d/Vyde706h7w66/zN37jlXi1a/M6ecuK3/Zb/H484AQCAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABF2x0OCgxcUiq0t0Ft+tWxYnVZ/f57O5GOaNE/f3lnu1aPX78YgTAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACDoinnGvy3OvV79G3zd4jM/YfXdXbxXq57e39VdGbfsZpjjBAAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAEPTrpy/gL1NdrmExzJbFd+TzOXNdi9/B1WU1i9/BN39j8XlcwQkAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAEHRidvcpJ2ZSn7D4OVbnwi/eqzdumdl+ywz2xXd31eJuBr7ICQAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIKi8ZKG8lOLEIpJbFqosLju55d1dfH6nLC5nqn5ns5wAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEG/fvoC/qATM6afWrymz8fMb/7Z6vM7cV2L39vVHRO3WNyb8O2cAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAgq5YaDDsxAKPN04svkgu13jpliUs1Xf3jeqinvL3fI4TAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACDoprnMt8wIf2px/vobN72LixZ3M6y+V4v36o3F38TV393VZ/itnAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIKSCxB+W10wsbhcY/U9ueVzLHrz/Xh6fxeXa61aXc60+MzLv4mPOAEAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAgn799AX8ZRbnP5fndz9Vnj2/+O4uXtPn033fT8zQX7X6Ln4rJwAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgKCbFiDcsviiuqjnjepnP7EA6haW1WxZfXdP/P+Y4wQAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACLpinvFvi3PhV+den7D4PE5YnT1vx8T3OfE9X/0tWXzfb3mvvp0TAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABA0E1LE54upXjz2W9ZfLG46GXxmj6fM+/VU7fcq1XVRT2L17Tqiv+dTgAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIEgAAECQAACAoCvmGf92y9zrW57J4szv1Wf+VHlO/1Or36dbdpcs7vw4YfW9esQJAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAg6IqFBr9Vl0wsLvxYtbqc6ZZnuLjgZvFzl93yPK74TXQCAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAARdMc+YSYsz299YnCt+y+z5E7sATrhlp8Ebi/sf3li9v9/KCQAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgSAAAQJAAAIOjXT1/AH7S4JOQWbxZlnFhws7hEp7wY5qkTz/yE1d+e6nvFFzkBAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIJu2gXwVHnu9YnZ5SfmkK/OYH/qlr0JT/9G+ZmfsPgb5/kNcQIAAEECAACCBAAABAkAAAgSAAAQJAAAIEgAAECQAACAIAEAAEECAACCBAAABAkAAAgqLwN6Y3GRxeLCj1NOLLhZtLpE58QCqOozv+VzlH+v5jgBAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAILsAuBvdmL2/FNvZrbfMt9+cc77ib0Jq7sZTrxXi9+p1Wc+xwkAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACDIMiC+y4llGYsLORav6fPZXNryxuLipNXlTCecWKKz+Myv4AQAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACLIL4JnVOe+LTswIP2Fxvv2qEzPbb3mvTlicib94TVlOAAAgSAAAQJAAAIAgAQAAQQIAAIIEAAAECQAACBIAABAkAAAgSAAAQJAAAIAgAQAAQeVlQJZSfK8Ti2FOLHqpLpNZfR6LVn9LTnwHn3rzjlgA9U2cAABAkAAAgCABAABBAgAAggQAAAQJAAAIEgAAECQAACBIAABAkAAAgCABAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADwP/8Fubb2U/mavEgAAAAASUVORK5CYII=\",\n \"type\": \"get-paid-qr\"\n }\n ]\n}"}],"_postman_id":"040f7ebe-dcd4-4c56-b15f-f3ef43effe4d"},{"name":"Get payment","id":"5cc5e479-a6bd-4f35-9d1a-6270a3ef0951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/payments/{{paymentId}}","description":"

Gets the specified payment by payment id

The guided walkthrough gives a basic workflow to API calls made after receiving your API credentials. It covers the general use case of

Generating an access token for authenticated calls
Setting up a webhook config on your merchant account to receive async updates
Creating a payment link to pass along to an end-user
Getting an update on a payment using information received in a webhook

\n","_postman_id":"5e005e34-e2e1-448d-97e4-7acb00e08404","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}}},{"name":"Authentication","item":[{"name":"Generate access token","event":[{"listen":"test","script":{"id":"f9a20cdc-1af4-48ca-a777-bd2077cbc25e","exec":["var jsonData = JSON.parse(responseBody);","pm.environment.set(\"token\", jsonData.access_token);"],"type":"text/javascript"}}],"id":"48e95dfa-ef92-4242-9caa-f8fe35cb8d57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"{{apiKey}}\",\n \"username\": \"{{apiUsername}}\",\n \"password\": \"{{apiPassword}}\",\n \"audience\": \"{{authAudience}}\",\n \"grant_type\": \"{{authGrantType}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{authTenat}}.auth0.com/oauth/token","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"30b3f70d-8018-4800-b948-6e0b1fbeffa0","id":"30b3f70d-8018-4800-b948-6e0b1fbeffa0","name":"Authentication","type":"folder"}},"urlObject":{"protocol":"https","path":["oauth","token"],"host":["{{authTenat}}","auth0","com"],"query":[],"variable":[]}},"response":[{"id":"052df852-6abf-48c2-a208-8e8359b5bee7","name":"Generate access token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"audience\": \"https://banq.com/open/api/\",\n \"grant_type\": \"client_credentials\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{authTenat}}.auth0.com/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 17 Dec 2020 20:51:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"603385c229cb2deb-KBP"},{"key":"Cache-Control","value":"no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Vary","value":"Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"071411ed5a00002deb490d3000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"ot-baggage-auth0-request-id","value":"603385c229cb2deb"},{"key":"ot-tracer-sampled","value":"true"},{"key":"ot-tracer-spanid","value":"44ac0ca6221c8129"},{"key":"ot-tracer-traceid","value":"056723b774cb0821"},{"key":"Pragma","value":"no-cache"},{"key":"X-Auth0-RequestId","value":"a5f2819f4eb370885359"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-RateLimit-Limit","value":"1000000"},{"key":"X-RateLimit-Remaining","value":"999999"},{"key":"X-RateLimit-Reset","value":"1608238291"},{"key":"Server","value":"cloudflare"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ik5URXhSRUZETmpkRFF6UkZRelZEUmtFM1JqUXlPVFl4TlRneE1VUXdNVGM0TlRjeE1UTTBPUSJ9.eyJpc3MiOiJodHRwczovL2Rldi03N3V0a2hicC5hdXRoMC5jb20vIiwic3ViIjoiY0JiMGJoV2ZlTmp4QnBwWGlRNWd1VlN0VjRhYU9mRGtAY2xpZW50cyIsImF1ZCI6Imh0dHBzOi8vYmFucS5jb20vb3Blbi9hcGkvIiwiaWF0IjoxNjA4MjM4MjkwLCJleHAiOjE2MDgzMjQ2OTAsImF6cCI6ImNCYjBiaFdmZU5qeEJwcFhpUTVndVZTdFY0YWFPZkRrIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIn0.o7uwLe7lQRIvx1EpNYSB6mPzI7xb-zWiKPJEeXek_rZrOZDHcyeer9DSjd35dZmvuvaWrWuHLYlT7dOwdEXzim3yL6xYh3Xf1zy1dwrhCJnsy0krnH-xZ3e1EEFiZSB6uUKdyhmkboLP44w_mL4UxxeSvdBX5AEIHaAG7lhITKulU1zYSwWsHsyr5dxStgKzO9vmH63EuQJx8u3nwr8bZqzRebny5h0PMwozwyosoCAlR8xvATkFCmx0KVLkz7QmWZRszdEA7o7PDy6hX1X1zO3EZh2FOzUPG94NLGyVb8vX7sTtmy255J71WDT4RgFsLxlKvkXOPZB_lwd68hWHXQ\",\n \"expires_in\": 86400,\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"48e95dfa-ef92-4242-9caa-f8fe35cb8d57"}],"id":"30b3f70d-8018-4800-b948-6e0b1fbeffa0","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fb9cbfc5-9321-41b1-8219-2565f14eb7c7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"68441ed9-56ac-4bf4-8e92-91532dace64c"}}],"_postman_id":"30b3f70d-8018-4800-b948-6e0b1fbeffa0","description":""},{"name":"Banqs","item":[{"name":"Find banq by name, number or guid","id":"12fa71a7-313d-45ed-8d4d-65b14615f21a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/banqs?name={{banqName}}","description":"

Gets the BanqInfo by number, name or guid

Filters

\nname: \"Euphoria\" (banq name);\n\n

banqGuid: 2dd64995-c36e-4d76-9b67-ab9d46da8f5e (banq unique ID);

number: 420018405648 (banq ID (external)).

Response body

\ndata:\n\n

banqId (string, length - 12) - banq ID (external);
guid (Guid) - banq unique ID;
name (string) - banq name;
banqType: Limited, Full ;
accountType: Personal, Merchant;
IndustryIds (int).

Headers

\n\n

X-Company-Id

Gets the Banq by ID.

Response body.

\n\n

accountId (int) ;

id (int) - banq ID;

banqId (string, length - 12) - banq ID (external);

guid (Guid) - banq unique ID;

name (string) - banq name;

balance (decimal);

isPrimary (bool);

isNameSearchable (bool);

useTransactionName (bool);

transactionName (string, max length - 60);

banqType: Limited, Full.

Headers

\n\n

X-Company-Id

Creates the get paid link..

Request body

\n\n

destination - required:

banqguid (Guid) - required - banq unique ID;

funds (decimal) - required;

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

startDate (DateTime);

endDate (DateTime);

comment (string);

externalOrderCode (string).

Response body

\ndata:\n\n

url (string) - paid link;
\n
type (string) - response type;
\n

Headers

\n\n

X-Idempoent-Id

Gets the specified payment by payment id

Response body

\n\n

id (long) - payment ID;

guid (Guid) - payment banqGuid;

createdAt (DateTimeOffset) - payment creation date time;

updatedAt (DateTimeOffset) - payment updating date time;

name (string) - payment name;

status: Pending, Completed, Canceled, Declined, Expired, New, Active, OnHold - payment status;

createdBy (int) - ID of the user that created this payment.;

endDate (DateTime);

startDate (DateTime);

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

type: Pay, Move - transaction type;

flowType: Pay, GetPaid, Default;

expiresAt (DateTimeOffset);

moveType: Internal, Contribution, Disbursement, Pending;

disbursementType: Plaid, Ach, InternationalWire, Check, Wire, NotSpecified;

contributionType: Wire, Check, InternationalWire, Plaid, Card;

reference (string);

externalOrderCode (string);

source:

accountId (int);
banq:
- id (int) - banq id;
- banqGuid (Guid) - banq unigue ID;
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

destination:

accountId (int);
banq:
- id (int);
- banqGuid (Guid);
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

comment (string);

funds (decimal);

tips (decimal).

Creates the direct get paid payment.

Request body

\n\n

source - required:

banqguid (Guid) - required - source banq unique ID;

destination - required:

banqguid (Guid) - required - destination banq unique ID;

funds (decimal) - required;

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

startDate (DateTime);

endDate (DateTime);

comment (string);

externalOrderCode (string).

Response body

\n\n

id (long) - payment ID;

guid (Guid) - payment banqGuid;

createdAt (DateTimeOffset) - payment creation date time;

updatedAt (DateTimeOffset) - payment updating date time;

name (string) - payment name;

status: Pending, Completed, Canceled, Declined, Expired, New, Active, OnHold - payment status;

createdBy (int) - ID of the user that created this payment.;

endDate (DateTime);

startDate (DateTime);

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

type: Pay, Move - transaction type;

flowType: Pay, GetPaid, Default;

expiresAt (DateTimeOffset);

moveType: Internal, Contribution, Disbursement, Pending;

disbursementType: Plaid, Ach, InternationalWire, Check, Wire, NotSpecified;

contributionType: Wire, Check, InternationalWire, Plaid, Card;

reference (string);

externalOrderCode (string);

source:

accountId (int);
banq:
- id (int);
- banqGuid (Guid);
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

destination:

accountId (int);
banq:
- id (int);
- banqGuid (Guid);
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

comment (string);

funds (decimal);

tips (decimal).

Headers

\n* X-Idempoent-Id","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","payments","get-paid-direct"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9356be0b-13ce-4b8c-a9e0-cc3f9972d22d","name":"Create Get Paid payment","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true},{"key":"X-Idempotent-Id","value":"dc36860d-5610-4752-92da-0e78223cb83b","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source\": {\r\n \"banqGuid\": \"{{sourceBanqGuid}}\"\r\n },\r\n \"destination\": {\r\n \"banqGuid\": \"{{banqGuid}}\"\r\n },\r\n \"funds\": 1,\r\n \"frequency\": \"once\",\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"comment\": \"order description\",\r\n \"externalOrderCode\": \"# form other system\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/payments/get-paid-direct"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 11:29:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 16038,\n \"guid\": \"9fc36ff2-2488-4977-bbe2-45039d5d4183\",\n \"createdAt\": \"2021-01-11T11:29:37.3411354+00:00\",\n \"updatedAt\": \"2021-01-11T11:29:37.3411354+00:00\",\n \"status\": \"pending\",\n \"createdBy\": 3477,\n \"startDate\": \"2021-01-11\",\n \"frequency\": \"once\",\n \"flowType\": \"getPaid\",\n \"type\": \"pay\",\n \"moveType\": \"pending\",\n \"externalOrderCode\": \"# form other system\",\n \"source\": {\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n },\n \"type\": \"banq\",\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\"\n },\n \"destination\": {\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n },\n \"type\": \"banq\",\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\"\n },\n \"comment\": \"order description\",\n \"funds\": 1,\n \"tips\": 0\n}"}],"_postman_id":"3e969317-3e92-483b-94aa-9320588fab95"},{"name":"Create Get Paid payment link","id":"6fbfbfec-773e-44eb-b3e4-edf7e5321dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Idempotent-Id","value":"a6e114ce-9d2b-4e02-9fbe-267d09433de0","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"destination\": {\r\n \"banqGuid\": \"{{banqGuid}}\"\r\n },\r\n \"funds\": 1,\r\n \"frequency\": \"once\",\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"comment\": \"order description\",\r\n \"externalOrderCode\": \"# form other system\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/payments/get-paid-link","description":"

Creates the get paid link..

Request body

\n\n

destination - required:

banqguid (Guid) - required - banq unique ID;

funds (decimal) - required;

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

startDate (DateTime);

endDate (DateTime);

comment (string);

externalOrderCode (string).

Response body

\ndata:\n\n

url (string) - paid link;
\n
type (string) - response type;
\n

Headers

Creates the get paid link..

Request body

\n\n

destination - required:

banqguid (Guid) - required - banq unique ID;

funds (decimal) - required;

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

startDate (DateTime);

endDate (DateTime);

comment (string);

externalOrderCode (string).

Response body

\ndata:\n\n

size: Small, Medium, Large - QR code image size;
\n
base64Content (string) - QR code base64 encoded;
\n
type (string) - type of response.
\n

Headers

Creates the get paid link..

Request body

\n\n

destination - required:

banqguid (Guid) - required - banq unique ID;

funds (decimal) - required;

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

startDate (DateTime);

endDate (DateTime);

comment (string);

externalOrderCode (string).

Response body

\ndata:\n\n

url (string) - paid link;
\n
type (string) - response type;
\n

Headers

\n* X-Idempoent-Id","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","payments","pay-direct"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ad74f57b-3e7f-4550-a329-ffaa1c433699","name":"Create Pay Direct payment","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true},{"key":"X-Idempotent-Id","value":"5052eff2-4647-4734-bc2f-c0c86eb765a9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"source\": {\r\n \"banqGuid\": \"{{sourceBanqGuid}}\"\r\n },\r\n \"destination\": {\r\n \"banqGuid\": \"{{banqGuid}}\"\r\n },\r\n \"comment\": \"order description\",\r\n \"funds\": 1,\r\n \"tips\": 1,\r\n \"repeatTip\": false,\r\n \"externalOrderCode\": \"# form other system\",\r\n \"frequency\": \"once\",\r\n \"startDate\": null,\r\n \"endDate\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/payments/pay-direct"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 11:30:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 498,\n \"guid\": \"f4002133-4c51-4099-9740-77fbc501a970\",\n \"createdAt\": \"2021-05-17T12:35:46.6201908+00:00\",\n \"updatedAt\": \"2021-05-17T12:35:48.3797781+00:00\",\n \"status\": \"completed\",\n \"createdBy\": 1090,\n \"performedBy\": 1090,\n \"endDate\": \"2021-05-17\",\n \"startDate\": \"2021-05-17\",\n \"frequency\": \"once\",\n \"flowType\": \"default\",\n \"type\": \"pay\",\n \"moveType\": \"internal\",\n \"externalOrderCode\": \"string\",\n \"paymentFlowDirection\": \"moneyOutRequest\",\n \"paymentViewModelGuid\": \"7c064869-6aac-4f14-991a-666e3dbd86d3\",\n \"unitCount\": 0,\n \"assetOperation\": \"none\",\n \"source\": {\n \"accountId\": 1188,\n \"banq\": {\n \"id\": 1763,\n \"banqGuid\": \"a982e719-ec0e-42b0-a890-1cb0676995f6\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420015945701,\n \"banqName\": \"stkhokfaejnoqhppibvcqbzasondmaydox\",\n \"banqNickName\": \"stkhokfaejnoqhppibvcqbzasondmaydox\",\n \"transactionName\": \"stkhokfaejnoqhppibvcqbzasondmaydox\"\n },\n \"accountType\": \"personal-account-space\",\n \"type\": \"banq\",\n \"banqGuid\": \"a982e719-ec0e-42b0-a890-1cb0676995f6\"\n },\n \"destination\": {\n \"accountId\": 1189,\n \"banq\": {\n \"id\": 1764,\n \"banqGuid\": \"fd35e90d-6da8-4bd4-9538-f2f058637c5d\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420026884200\n },\n \"accountType\": \"personal-account-space\",\n \"type\": \"banq\",\n \"banqGuid\": \"fd35e90d-6da8-4bd4-9538-f2f058637c5d\"\n },\n \"comment\": \"order description\",\n \"funds\": 1,\n \"tips\": 0,\n \"repeatTip\": true\n}"}],"_postman_id":"96d301b8-1b9f-4c81-ba81-f7079a218911"}],"id":"0b31d80b-3dd4-45cf-8ab5-114cee9771a5","_postman_id":"0b31d80b-3dd4-45cf-8ab5-114cee9771a5","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}}},{"name":"Transactions","item":[{"name":"Get transactions","event":[{"listen":"test","script":{"id":"e8c93519-1ffa-44cf-ba26-9897da01427d","exec":[""],"type":"text/javascript"}}],"id":"35167823-ae3e-4c0a-baa7-a423c59d33dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/transactions?filter[banq.id]={{banqId}}&pageSize=10&page=1","description":"

Gets transactions according to filters.

Filters

\nfilter[account.id]: 4152 (account ID);\n\n

filter[banq.id]: 4924 (banq ID);

filter[banq.guid]: \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\" (banq unique ID);

filter[payment.guid]: \"f6b659cb-8bc2-4d8c-b38d-c63f88aba492\" (payment unique ID);

filter[direction]: \"in\" (money transfer direction);

filter[type]: \"Move\" (transaction type);

filter[status]: \"New\" (transaction status);

filter[source.id]: 420099031248 (source custodial account ID).

Response body.

\n\n

meta:

resourseCount (int);

pageCount (int);

data:

id (long);

guid (Guid) - transaction guid;

type: Move, Pay - type of transaction;

flowType: Pay, GetPaid, Default;

moveType: Internal, Contribution, Disbursement, Pending;

disbursementType: Plaid, Ach, InternationalWire, Check, Wire, NotSpecified;

paymentGuid (Guid) - payment unique ID;

contributionType: Wire, Check, InternationalWire, Plaid, Card;

reference (string);

externalOrderCode (string);

recurrence:

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;
\n
startDate (DateTime);
\n
endDate (DateTime);
\n

source:

userId (int) - user ID;
\n
type: Banq, External - address type;
\n
accountType: Personal, Merchant;
\n
accountId (int);
\n
banq:
\n
- id (int) - banq ID;
  \n
- banqGuid (Guid) - banq unique ID;
  \n
- banqType: Limited, Full;
  \n
- custodialNumber (long);
  \n
- banqName (string);
  \n
- transactionName (string);
  \n
\n
externalAccount:
\n
- id (int) - external account ID;
- type: Bank, Card - external account type;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalContributionSource:
\n
- fundsSourceName (string);
- settlementDetails (string);
\n
externalDisbursementDestination:
\n
- beneficiaryAddress (string);
  - street1 (string);
  - street2 (string);
  - postalCode (string);
  - city (string);
  - state (string);
  - country (string);
  \n
- checkPayee (string);
- bankAccountName (string);
- routingNumber (string);
- bankAccountNumber (string);
- settlementDetails (string);
\n

destination:

userId (int) - user ID;
\n
type: Banq, External - address type;
\n
accountType: Personal, Merchant;
\n
accountId (int);
\n
banq:
\n
- id (int) - banq ID;
  \n
- banqGuid (Guid) - banq unique ID;
  \n
- banqType: Limited, Full;
  \n
- custodialNumber (long);
  \n
- banqName (string);
  \n
- transactionName (string);
  \n
\n
externalAccount:
\n
- id (int) - external account ID;
- type: Bank, Card - external account type;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalContributionSource:
\n
- fundsSourceName (string);
- settlementDetails (string);
\n
externalDisbursementDestination:
\n
- beneficiaryAddress (string);
  - street1 (string);
  - street2 (string);
  - postalCode (string);
  - city (string);
  - state (string);
  - country (string);
  \n
- checkPayee (string);
- bankAccountName (string);
- routingNumber (string);
- bankAccountNumber (string);
- settlementDetails (string);
\n

amount (decimal) - funds;

fee (decimal) - fee amount;

sourceFee (decimal);

destinationFee (decimal);

total (decimal) - total amount;

comment (string);

status: New, Processing, Completed, Failed, Declined - transaction status;

createdAt (DateTimeOffset) - time of creation transaction;

updatedAt (DateTimeOffset) - time of updating transaction;

failReason: ProcessingFailed, LimitsExceeded, BanqError, PrimeTrustError, InsufficientBalance, CustodialAccountContactIsNotApproved, ExternalAccountIsDeactivated, PlaidRequiresReAuthentication, AccountIsFrozen;

failReasonDetails (string).

Headers

","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","transactions"],"host":["{{baseUrl}}"],"query":[{"key":"filter[banq.id]","value":"{{banqId}}"},{"key":"pageSize","value":"10"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"0e1b9ae4-e8fb-42fd-a471-b2f8b75d2e2d","name":"Get transactions by banq id","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/transactions?filter[banq.id]={{banqId}}&PageSize=10&Page=1","host":["{{baseUrl}}"],"path":["v1","transactions"],"query":[{"key":"filter[banq.id]","value":"{{banqId}}"},{"key":"PageSize","value":"10"},{"key":"Page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 15:35:35 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"resourceCount\": 14,\n \"pageCount\": 2\n },\n \"data\": [\n {\n \"id\": 39097,\n \"guid\": \"4c686db0-5275-480a-a28e-919c490293da\",\n \"type\": \"pay\",\n \"flowType\": \"default\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"85e81027-c5ea-4a6a-908d-b0d48c880221\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-31T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 3,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 3,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-31T14:10:58.8864217+00:00\",\n \"updatedAt\": \"2020-12-31T14:11:00.4018767+00:00\"\n },\n {\n \"id\": 38523,\n \"guid\": \"ec542c7e-000a-4b90-893f-90d320838ab1\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"a618b327-28d5-490b-bc00-9ef69859d043\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-30T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 1,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 1,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-30T15:10:30.6314221+00:00\",\n \"updatedAt\": \"2020-12-30T15:10:32.3703414+00:00\"\n },\n {\n \"id\": 37461,\n \"guid\": \"2bd7a1f4-a512-4480-81d5-bcaf155702fc\",\n \"type\": \"pay\",\n \"flowType\": \"default\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"5fd6c6d4-d034-4555-ad96-dbd06d83ed01\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-28T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 3,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 3,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-28T13:31:22.0758379+00:00\",\n \"updatedAt\": \"2020-12-28T13:31:23.4395673+00:00\"\n },\n {\n \"id\": 37460,\n \"guid\": \"e2ea20d3-536d-4e8b-8225-e5e6e75b686c\",\n \"type\": \"pay\",\n \"flowType\": \"default\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"7fcb575a-17dd-495e-8fc9-debcda7799e2\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-28T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 13,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 13,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-28T13:28:35.7337962+00:00\",\n \"updatedAt\": \"2020-12-28T13:28:37.2984025+00:00\"\n },\n {\n \"id\": 37430,\n \"guid\": \"f9a43e7c-8729-4bfa-9a71-2a38699656b1\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"b8d315ee-2f1f-4702-b220-88aee2e765a5\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-28T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 11,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 11,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-28T13:12:31.619627+00:00\",\n \"updatedAt\": \"2020-12-28T13:12:33.4816589+00:00\"\n },\n {\n \"id\": 37429,\n \"guid\": \"4616a980-f58b-4ef9-b792-a483a9872988\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"ca74fd26-de0d-4eb8-b50b-2fa5cfe48d60\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-28T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 11,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 11,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-28T13:11:56.1013832+00:00\",\n \"updatedAt\": \"2020-12-28T13:11:57.9056647+00:00\"\n },\n {\n \"id\": 36714,\n \"guid\": \"e5c78f8a-8b6e-43d4-be25-849eda1e9423\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"68fa5651-5172-48b1-aa31-51dad961e15d\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-24T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 1,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 1,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-24T15:04:58.7210163+00:00\",\n \"updatedAt\": \"2020-12-24T15:05:00.3136203+00:00\"\n },\n {\n \"id\": 36713,\n \"guid\": \"fa9ccfc2-c4a0-4e9f-8cce-81b2c92d3f67\",\n \"type\": \"pay\",\n \"flowType\": \"default\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"27af5b4f-b882-4b84-86f7-834682bc6938\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-24T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 2,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 2,\n \"comment\": \"order description\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-24T15:00:20.195995+00:00\",\n \"updatedAt\": \"2020-12-24T15:00:24.3037852+00:00\"\n },\n {\n \"id\": 36711,\n \"guid\": \"6049acca-0161-4d9b-9863-69be93f0f96d\",\n \"type\": \"pay\",\n \"flowType\": \"default\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"c204de22-8c1b-4c9f-b40f-7b8008bb930a\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-24T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 1,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 1,\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-24T14:52:45.6774338+00:00\",\n \"updatedAt\": \"2020-12-24T14:52:47.2983028+00:00\"\n },\n {\n \"id\": 36707,\n \"guid\": \"33a8b6b1-56bc-404f-85c6-de99aaf0c7f0\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"2b5ea7d6-0558-48b9-b630-31501bd49434\",\n \"externalOrderCode\": \"# form other system\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-24T00:00:00\"\n },\n \"source\": {\n \"userId\": 3915,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 4638,\n \"banq\": {\n \"id\": 5439,\n \"banqGuid\": \"53c34945-61a2-4140-a543-6e66622c8cfc\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420099031248,\n \"transactionName\": \"Money Source\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 1,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 1,\n \"comment\": \"test payment\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-24T13:57:52.0624173+00:00\",\n \"updatedAt\": \"2020-12-24T13:57:54.8719286+00:00\"\n }\n ]\n}"}],"_postman_id":"35167823-ae3e-4c0a-baa7-a423c59d33dc"},{"name":"Get transaction by Id","id":"14d771e8-349e-45cf-b4b7-a9c5d2a3bd43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/transactions/{{transactionId}}","description":"

Gets the transaction by unique identifier.

Response body

\nid (long);\n\n

guid (Guid) - transaction guid;

type: Move, Pay - type of transaction;

flowType: Pay, GetPaid, Default;

moveType: Internal, Contribution, Disbursement, Pending;

disbursementType: Plaid, Ach, InternationalWire, Check, Wire, NotSpecified;

paymentGuid (Guid) - payment unique ID;

contributionType: Wire, Check, InternationalWire, Plaid, Card;

reference (string);

externalOrderCode (string);

recurrence:

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;
\n
startDate (DateTime);
\n
endDate (DateTime);
\n

source:

userId (int) - user ID;
\n
type: Banq, External - address type;
\n
accountType: Personal, Merchant;
\n
accountId (int);
\n
banq:
\n
- id (int) - banq ID;
  \n
- banqGuid (Guid) - banq unique ID;
  \n
- banqType: Limited, Full;
  \n
- custodialNumber (long);
  \n
- banqName (string);
  \n
- transactionName (string);
  \n
\n
externalAccount:
\n
- id (int) - external account ID;
- type: Bank, Card - external account type;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalContributionSource:
\n
- fundsSourceName (string);
- settlementDetails (string);
\n
externalDisbursementDestination:
\n
- beneficiaryAddress (string);
  - street1 (string);
  - street2 (string);
  - postalCode (string);
  - city (string);
  - state (string);
  - country (string);
  \n
- checkPayee (string);
- bankAccountName (string);
- routingNumber (string);
- bankAccountNumber (string);
- settlementDetails (string);
\n

destination:

userId (int) - user ID;
\n
type: Banq, External - address type;
\n
accountType: Personal, Merchant;
\n
accountId (int);
\n
banq:
\n
- id (int) - banq ID;
  \n
- banqGuid (Guid) - banq unique ID;
  \n
- banqType: Limited, Full;
  \n
- custodialNumber (long);
  \n
- banqName (string);
  \n
- transactionName (string);
  \n
\n
externalAccount:
\n
- id (int) - external account ID;
- type: Bank, Card - external account type;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalContributionSource:
\n
- fundsSourceName (string);
- settlementDetails (string);
\n
externalDisbursementDestination:
\n
- beneficiaryAddress (string);
  - street1 (string);
  - street2 (string);
  - postalCode (string);
  - city (string);
  - state (string);
  - country (string);
  \n
- checkPayee (string);
- bankAccountName (string);
- routingNumber (string);
- bankAccountNumber (string);
- settlementDetails (string);
\n

amount (decimal) - funds;

fee (decimal) - fee amount;

sourceFee (decimal);

destinationFee (decimal);

total (decimal) - total amount;

comment (string);

status: New, Processing, Completed, Failed, Declined - transaction status;

createdAt (DateTimeOffset) - time of creation transaction;

updatedAt (DateTimeOffset) - time of updating transaction;

failReason: ProcessingFailed, LimitsExceeded, BanqError, PrimeTrustError, InsufficientBalance, CustodialAccountContactIsNotApproved, ExternalAccountIsDeactivated, PlaidRequiresReAuthentication, AccountIsFrozen;

failReasonDetails (string).

Headers

\n* X-Company-Id","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","transactions","{{transactionId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"5cb52867-24da-4152-be98-76cab533a4c9","name":"Get transaction by Id","originalRequest":{"method":"GET","header":[{"key":"","type":"text","value":"","disabled":true}],"url":"{{baseUrl}}/v1/transactions/{{transactionId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 11:29:09 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 35368,\n \"guid\": \"65755890-504f-439d-880b-e9432609d8d9\",\n \"type\": \"pay\",\n \"flowType\": \"getPaid\",\n \"moveType\": \"internal\",\n \"paymentGuid\": \"f6b659cb-8bc2-4d8c-b38d-c63f88aba492\",\n \"recurrence\": {\n \"frequency\": \"once\",\n \"startDate\": \"2020-12-18T00:00:00\"\n },\n \"source\": {\n \"userId\": 325,\n \"type\": \"banq\",\n \"accountType\": \"personal\",\n \"accountId\": 325,\n \"banq\": {\n \"id\": 325,\n \"banqGuid\": \"9d1d96f3-589a-4b3b-93d5-55c151f5aba0\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420091154606,\n \"transactionName\": \"Sergey\"\n }\n },\n \"destination\": {\n \"userId\": 3477,\n \"type\": \"banq\",\n \"accountType\": \"merchant\",\n \"accountId\": 4152,\n \"banq\": {\n \"id\": 4924,\n \"banqGuid\": \"2dd64995-c36e-4d76-9b67-ab9d46da8f5e\",\n \"banqType\": \"full\",\n \"custodialNumber\": 420018405648,\n \"banqName\": \"Euphoria\",\n \"transactionName\": \"Euphoria\"\n }\n },\n \"amount\": 100,\n \"fee\": 0,\n \"destinationFee\": 0,\n \"total\": 100,\n \"comment\": \"R-555555\",\n \"status\": \"completed\",\n \"createdAt\": \"2020-12-18T10:03:14.4151001+00:00\",\n \"updatedAt\": \"2020-12-18T10:03:15.4495023+00:00\"\n}"}],"_postman_id":"14d771e8-349e-45cf-b4b7-a9c5d2a3bd43"}],"id":"cb76b8b8-5307-4f94-9d60-7bed4c514dc8","_postman_id":"cb76b8b8-5307-4f94-9d60-7bed4c514dc8","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Create web hook config","id":"b9e20f5d-ab0d-433c-8106-0e4be30059f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://webhook.site/48cd50bf-ce90-4ca3-8652-a35a6b473091\",\r\n \"enabled\": true,\r\n \"retryCount\": 5,\r\n \"webHookTypes\": [\r\n \"payment\", \"transaction\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config","description":"

Create web hook config.

Request body

\n\n

url (string) - required, cannot be empty or contain whitespaces only;

enabled (bool) - 'true' by default;

retryCount (int, from 1 to 10) - required, the maximum number of requests that will be send to the url, until a success response is returned. There will be at least one request attempt;

sharedSecret (string) - at least 8 characters. If not present, a random value will be generated and returned;

webHookTypes (list of web hook types: transaction, payment) - required.

Response body

\ndata:\n\n

accountSpaceId (int) - account space ID;
id (int) - ID of the config;
url (string) - url of the config;
enabled (bool) - is config enabled;
guid (Guid) - unique ID of the config;
createdById (int) - ID of the user that created this config;
updatedById (int) - ID of the user that updated this config;
createdAtUtc (DateTimeOffset) - the create date time;
updatedAtUtc (DateTimeOffset) - the update date time;
retryCount (int) - retry count;
sharedSecret (string) - shared secret that will be used to calculate HMAC for the webhooks;
webHookTypes: Payment, Transaction - list of web hook types.

type (string) - type of response.

Headers

\n* X-Company-Id.","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","account-spaces","{{accountSpaceId}}","webhook-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"751ba4c3-f01b-47d1-b3da-2ce1f5f94a69","name":"Create web hook config","originalRequest":{"method":"POST","header":[{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://www.banq.com/payment\",\r\n \"enabled\": true,\r\n \"retryCount\": 1,\r\n \"sharedSecret\": \"secret\",\r\n \"webHookTypes\": [\r\n \"payment\", \"transaction\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Jan 2021 13:21:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Location","value":"http://aks-banq-int-01.eastus.cloudapp.azure.com/api/v1/accounts/4152/webhook-config"},{"key":"Request-Context","value":"appId=cid-v1:6ed5b5d4-9eae-41f7-b8cf-ecc8af6093c8"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accountSpaceId\": 4152,\n \"id\": 65,\n \"url\": \"https://www.banq.com/payment\",\n \"enabled\": true,\n \"guid\": \"2721be6e-eb4b-4fe5-a113-50a84cd816f0\",\n \"createdById\": 3477,\n \"updatedById\": 3477,\n \"createdAtUtc\": \"2021-01-18T13:21:18.4358792+00:00\",\n \"updatedAtUtc\": \"2021-01-18T13:21:18.4358792+00:00\",\n \"retryCount\": 1,\n \"sharedSecret\": \"secret\",\n \"webHookTypes\": [\n \"payment\",\n \"transaction\"\n ],\n \"type\": \"webhook-config\"\n }\n}"}],"_postman_id":"b9e20f5d-ab0d-433c-8106-0e4be30059f2"},{"name":"Update web hook config","id":"47bc1722-0803-4b33-84e2-7b6375b0c3ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://webhook.site/48cd50bf-ce90-4ca3-8652-a35a6b473091\",\r\n \"enabled\": true,\r\n \"retryCount\": 5,\r\n \"webHookTypes\": [\r\n \"payment\", \"transaction\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config","description":"

Update web hook config by account id.

Request body

\n\n

url (string) - required, cannot be empty or contain whitespaces only;

enabled (bool) - required;

retryCount (int, from 1 to 10) - required, the maximum number of requests that will be send to the url, until a success response is returned. There will be at least one request attempt;

webHookTypes (list of web hook types: transaction, payment) - required.

Response body

\ndata:\n\n

accountSpaceId (int) - account space ID;
id (int) - ID of the config;
url (string) - url of the config;
enabled (bool) - is config enabled;
guid (Guid) - unique ID of the config;
createdById (int) - ID of the user that created this config;
updatedById (int) - ID of the user that updated this config;
createdAtUtc (DateTimeOffset) - the create date time;
updatedAtUtc (DateTimeOffset) - the update date time;
retryCount (int) - retry count;
sharedSecret (string) - shared secret that will be used to calculate HMAC for the webhooks;
webHookTypes: Payment, Transaction - list of web hook types.

type (string) - type of response.

Headers

\n* X-Company-Id.","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","account-spaces","{{accountSpaceId}}","webhook-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"897da2e8-98f6-4156-95e1-612040973274","name":"Update web hook config","originalRequest":{"method":"PUT","header":[{"key":"","type":"text","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://www.banq.com/transaction\",\r\n \"enabled\": true,\r\n \"retryCount\": 1,\r\n \"webHookTypes\": [\r\n \"payment\", \"transaction\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Jan 2021 13:21:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Request-Context","value":"appId=cid-v1:6ed5b5d4-9eae-41f7-b8cf-ecc8af6093c8"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"accountSpaceId\": 4152,\n \"id\": 65,\n \"url\": \"https://www.banq.com/transaction\",\n \"enabled\": true,\n \"guid\": \"2721be6e-eb4b-4fe5-a113-50a84cd816f0\",\n \"createdById\": 3477,\n \"updatedById\": 3477,\n \"createdAtUtc\": \"2021-01-18T13:21:18.4358792+00:00\",\n \"updatedAtUtc\": \"2021-01-18T13:21:59.3786367+00:00\",\n \"retryCount\": 1,\n \"sharedSecret\": \"secret\",\n \"webHookTypes\": [\n \"payment\",\n \"transaction\"\n ],\n \"type\": \"webhook-config\"\n}"}],"_postman_id":"47bc1722-0803-4b33-84e2-7b6375b0c3ec"},{"name":"Get web hook config","id":"cfabab41-66cc-499b-8a7b-cb6027dfdf7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config","description":"

Loads web hook config for account.

Response body

\n\n

accountSpaceId (int) - account space ID;
id (int) - ID of the config;
url (string) - url of the config;
enabled (bool) - is config enabled;
guid (Guid) - unique ID of the config;
createdById (int) - ID of the user that created this config;
updatedById (int) - ID of the user that updated this config;
createdAtUtc (DateTimeOffset) - the create date time;
updatedAtUtc (DateTimeOffset) - the update date time;
retryCount (int) - retry count;
sharedSecret (string) - shared secret that will be used to calculate HMAC for the webhooks;
webHookTypes: Payment, Transaction - list of web hook types.
type (string) - type of response.

Headers

\n* X-Company-Id","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","account-spaces","{{accountSpaceId}}","webhook-config"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"42f5a0ce-e129-477b-aa75-b52a4a0a36f1","name":"Get web hook config","originalRequest":{"method":"GET","header":[{"key":"","value":"","type":"text","disabled":true}],"url":"{{baseUrl}}/v1/account-spaces/{{accountSpaceId}}/webhook-config"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Jan 2021 13:22:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Request-Context","value":"appId=cid-v1:6ed5b5d4-9eae-41f7-b8cf-ecc8af6093c8"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=15724800; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"accountSpaceId\": 4152,\n \"id\": 65,\n \"url\": \"https://www.banq.com/transaction\",\n \"enabled\": true,\n \"guid\": \"2721be6e-eb4b-4fe5-a113-50a84cd816f0\",\n \"createdById\": 3477,\n \"updatedById\": 3477,\n \"createdAtUtc\": \"2021-01-18T13:21:18.4358792+00:00\",\n \"updatedAtUtc\": \"2021-01-18T13:21:59.3786367+00:00\",\n \"retryCount\": 1,\n \"sharedSecret\": \"secret\",\n \"webHookTypes\": [\n \"payment\",\n \"transaction\"\n ],\n \"type\": \"webhook-config\"\n }\n}"}],"_postman_id":"cfabab41-66cc-499b-8a7b-cb6027dfdf7b"}],"id":"b0f78397-e48f-41f5-8389-390ef22743f2","_postman_id":"b0f78397-e48f-41f5-8389-390ef22743f2","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}}},{"name":"Nft Transactions","item":[{"name":"Create Move Nft Transaction","id":"0949f2aa-6bac-4500-92b5-307105db4a94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Idempotent-Id","value":"d6eb1ec2-f0ed-4a72-9a14-9fbe8f923143","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"tokenId\": \"token Id\",\r\n \"contractAddress\": \"сontract address\",\r\n \"sourceBanq\": \"{{sourceBanqGuid}}\",\r\n \"destinationBanq\": \"{{banqGuid}}\",\r\n \"amount\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/nft-transactions","description":"

Creates the direct get paid payment.

Request body

\n\n

source - required:

sourceBanq (Guid) - required - source banq unique ID;

destination - required:

destinationBanq (Guid) - required - destination banq unique ID;

amount (decimal) - required;

contractAddress (string);

tokenId (string);

Response body

\n\n

id (long) - payment ID;

guid (Guid) - payment banqGuid;

createdAt (DateTimeOffset) - payment creation date time;

updatedAt (DateTimeOffset) - payment updating date time;

name (string) - payment name;

status: Pending, Completed, Canceled, Declined, Expired, New, Active, OnHold - payment status;

createdBy (int) - ID of the user that created this payment.;

endDate (DateTime);

startDate (DateTime);

frequency: Once, Daily, Weekly, Biweekly, Monthly, Quarterly, EverySixMonths, Yearly - payment frequency;

type: Pay, Move - transaction type;

flowType: Pay, GetPaid, Default;

expiresAt (DateTimeOffset);

moveType: Internal, Contribution, Disbursement, Pending;

disbursementType: Plaid, Ach, InternationalWire, Check, Wire, NotSpecified;

contributionType: Wire, Check, InternationalWire, Plaid, Card;

reference (string);

externalOrderCode (string);

source:

accountId (int);
banq:
- id (int);
- banqGuid (Guid);
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

destination:

accountId (int);
banq:
- id (int);
- banqGuid (Guid);
- banqType: Limited, Full;
- custodialNumber (long);
- banqName (string);
- transactionName (string);
\n
externalAccount:
- id (int);
- type: Bank, Card;
- bankName (string);
- cardType: Debit, Credit;
- paymentSystem: Visa, Mastercard;
- last4 (string);
\n
externalAccountId (int);
type: Banq, External - address type;
banqGuid (Guid);

comment (string);

funds (decimal);

tips (decimal).

Headers

\n* X-Idempoent-Id","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}},"urlObject":{"path":["v1","nft-transactions"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a29e52e2-f8bf-44c0-81da-8e500f7a1381","name":"Create Move Nft transaction","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true},{"key":"X-Idempotent-Id","value":"71050f0d-442b-414f-aa2c-449d6ecfad8e","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"tokenId\": \"token Id\",\r\n \"contractAddress\": \"contract address\",\r\n \"sourceBanq\": \"{{sourceBanqGuid}}\",\r\n \"destinationBanq\": \"{{banqGuid}}\",\r\n \"amount\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/nft-transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Request-Context","value":"appId=cid-v1:4a170221-1561-450b-b172-8de5d316aaf6"},{"key":"api-supported-versions","value":"1.0"},{"key":"Date","value":"Mon, 11 Jan 2021 11:29:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 13953,\n \"guid\": \"4c2171f3-5468-4e79-a171-b2dd7e370149\",\n \"createdAt\": \"2021-09-07T15:19:53.5961102+00:00\",\n \"updatedAt\": \"2021-09-07T15:19:53.9681985+00:00\",\n \"status\": \"completed\",\n \"createdBy\": \"e011d65c-60c1-460e-b9c3-d59a15978b07\",\n \"performedBy\": \"e011d65c-60c1-460e-b9c3-d59a15978b07\",\n \"startDate\": \"2021-09-07\",\n \"frequency\": \"once\",\n \"flowType\": \"default\",\n \"type\": \"move\",\n \"moveType\": \"nft\",\n \"unitCount\": 0,\n \"assetOperation\": \"none\",\n \"tokenDataId\": \"d3c7e42b-82f1-1121-a92b-052ed7f24c2d\",\n \"nftName\": \"fgh\",\n \"nftDescription\": \"fgh\",\n \"nftAmount\": 1,\n \"mediaType\": \"image/png\",\n \"nftOperation\": \"move\",\n \"source\": {\n \"accountId\": 22502,\n \"banq\": {\n \"id\": 24204,\n \"banqGuid\": \"a56a3617-3fbe-4e6f-9d9a-6656ff0c50b1\",\n \"banqName\": \"nft\",\n \"banqNickName\": \"nft\",\n \"transactionName\": \"Nft\"\n },\n \"accountType\": \"merchant-account-space\",\n \"type\": \"banq\",\n \"banqGuid\": \"a56a3617-3fbe-4e6f-9d9a-6656ff0c50b1\"\n },\n \"destination\": {\n \"accountId\": 2,\n \"banq\": {\n \"id\": 2,\n \"banqGuid\": \"dce66689-30af-44bb-9d66-89c93a7251f0\",\n \"custodialNumber\": 420019364003,\n \"banqName\": \"reviewme\",\n \"transactionName\": \"ReviewMe\"\n },\n \"accountType\": \"personal-account-space\",\n \"type\": \"banq\",\n \"banqGuid\": \"dce66689-30af-44bb-9d66-89c93a7251f0\"\n },\n \"funds\": 0,\n \"tips\": 0,\n \"repeatTip\": false\n }\n}"}],"_postman_id":"0949f2aa-6bac-4500-92b5-307105db4a94"}],"id":"372d446f-d8bf-47bb-8c1b-ad28b9ae0638","_postman_id":"372d446f-d8bf-47bb-8c1b-ad28b9ae0638","description":"","auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":true,"source":{"_postman_id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","id":"22a6a5b1-a0f6-458c-be1d-b1eee0a7a570","name":"Banq Open API Documentation","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2160ac29-bd11-43e2-a272-8a571c0ff06a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b0fc39cb-da78-4229-991f-0670554ae90f"}}]}