Kanastra
Kanastra is a Brazilian fintech building full-stack infrastructure for banking and the private credit market. Its Banking API offers banking-as-a-service capabilities to financial institutions, funds and securitization vehicles: financial (checking) accounts with balances and transactions, PIX (key registration, transfers, deposits, and static/dynamic QR Codes on the BR Code / EMV-QRCPS standard), boleto (bank slip) issuance with CNAB return-file processing settled via the Nuclea clearing house, TED transfers, wallets, commercial notes (CCB) with guarantees and documents, and issuers. Authentication uses a private_key_jwt (ES512 client-assertion) flow that returns a scoped Bearer JWT, and a webhook surface streams bank slip and CNAB lifecycle events. Kanastra is backed by QED Investors, Kaszek, Valor Capital, Quona Capital, Itau, IFC and F-Prime.
Kanastra publishes 1 API on the APIs.io network: Banking API. Tagged areas include Company, Banking, Banking as a Service, Payments, and PIX.
The Kanastra catalog on APIs.io includes 1 event-driven AsyncAPI specification.
Kanastra’s developer surface includes documentation, API reference, authentication, and 4 more developer resources.
API Rating
API Evangelist Rating
How this is scored →scored 2026-07-20 · rubric v0.4
APIs
Kanastra Banking API
Brazilian banking-as-a-service API: financial accounts, PIX (keys, transfers, deposits, QR Codes), boleto (bank slip) issuance and CNAB return files, TED transfers, wallets, com...
Collections
Kanastra Banking
POSTMANEvent Specifications
Kanastra Banking Webhooks
Webhook event surface for Kanastra Banking. Subscribing systems receive JSON payloads for bank slip (boleto) lifecycle and CNAB file-processing events. Captured from the provide...
ASYNCAPIResources
Get Started 1
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Access & Security 2
Authentication, authorization, and security posture
Company 2
The organization behind the API
Source (apis.yml)
info:
_postman_id: 7af0120b-6a9b-4b32-89eb-d94facc7cdd1
name: Kanastra Banking
description: '<html><head></head><body><p><strong>API Documentation for Our Products</strong></p>
<p>Within this documentation, you will find detailed information about the available APIs for our products. Should you
have any inquiries or wish to report an issue, please contact us via email at the following address:</p>
<p><a href="https://pagamentos@kanastra.com.br">pagamentos@kanastra.com.br</a></p>
<p>We are committed to providing prompt assistance and appreciate your feedback.</p>
</body></html>'
schema: https://schema.getpostman.com/json/collection/v2.0.0/collection.json
toc: []
owner: '35321848'
collectionId: 7af0120b-6a9b-4b32-89eb-d94facc7cdd1
publishedId: 2sA3drHEUr
public: true
customColor:
top-bar: FFFFFF
right-sidebar: '303030'
highlight: FF6C37
publishDate: '2024-11-28T18:22:58.000Z'
item:
- name: Authentication
item:
- name: Create JWKS
id: 84d8684c-edc5-4a06-b943-cde52efb9a2a
protocolProfileBehavior:
disableBodyPruning: true
request:
method: POST
header: []
body:
mode: raw
raw: "{\n \"clientId\": \"{{client_id}}\",\n \"publicKey\": \"{{public_key}}\"\n}"
options:
raw:
language: json
url: '{{base_url}}/api/v1/auth/jwks'
description: '<p>For the public key, we use the ES512 algorithm. To generate this key, you can use OpenSSL as shown
in the example below:</p>
<pre class="click-to-expand-wrapper is-snippet-wrapper"><code class="language-bash">openssl ecparam -name secp521r1
-genkey -noout -out ec-p512-private.pem
openssl ec -in ec-p512-private.pem -pubout -out ec-p512-public.pem
</code></pre>
<p>And send the content of the <strong><code>ec-p512-public.pem</code></strong> file in the <strong><code>publicKey</code></strong>
attribute.</p>
'
urlObject:
path:
- api
- v1
- auth
- jwks
host:
- '{{base_url}}'
query: []
variable: []
response:
- id: f4d68c50-3dd1-41e1-a4be-b1a42411fb66
name: OK Create JWKS
originalRequest:
method: POST
header: []
body:
mode: raw
raw: "{\n \"clientId\": \"tech-hub-client\",\n \"publicKey\": \"{{public_key}}\"\n}"
options:
raw:
language: json
url: https://banking-sandbox.kanastra.com.br/api/v1/auth/jwks
status: Created
code: 201
_postman_previewlanguage: json
header:
- key: Date
value: Thu, 27 Jun 2024 21:06:17 GMT
- key: Content-Type
value: application/json
- key: Content-Length
value: '460'
- key: Connection
value: keep-alive
- key: vary
value: Accept, origin, Accept-Encoding
- key: allow
value: POST, OPTIONS
- key: x-frame-options
value: DENY
- key: content-encoding
value: gzip
- key: x-content-type-options
value: nosniff
- key: referrer-policy
value: no-referrer-when-downgrade
- key: cross-origin-opener-policy
value: same-origin
- key: x-request-id
value: 67e7d82d179b0dd2c865ca740377edd5
- key: Strict-Transport-Security
value: max-age=63072000; includeSubDomains; preload
- key: CF-Cache-Status
value: DYNAMIC
- key: Report-To
value: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=sAeWHQYt9BC7oVOli2hYsix6UwSMhy8nxqC3kfREslN%2Frc1SSAxCO8UFw%2FZsvkGX0%2FyXK0%2FeEAhwJcg%2Bu%2BQfZWiXKjIv3Vjc4xTSNLRuUcHd46NrIcfdf3Yw6hy71cM73EBib%2BrW%2F11T2Xl7a2cKimzk"}],"group":"cf-nel","max_age":604800}'
- key: NEL
value: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
- key: Server
value: cloudflare
- key: CF-RAY
value: 89a86666f8e5011a-GRU
- key: alt-svc
value: h3=":443"; ma=86400
cookie: []
responseTime: null
body: "{\n \"uuid\": \"70037f67-40f0-460d-8368-fd516ef28c42\",\n \"clientId\": \"demonstracao-client\",\n \"\
keys\": [\n {\n \"crv\": \"P-521\",\n \"kty\": \"EC\",\n \"x\": \"AV3vlyI1_7BvAhFShg0HvKmcjncxxDWBFn1BFzbu55-wZaMAlmOQLWe9-pdvY-gICYceIZvjGbdSvBzBXl8NIkuv\"\
,\n \"y\": \"AS6lXeFlTp7bJ9nrwHDZok9Z3ZgEKVWmQigq4WA4izGRXafp1s_GO4MntnD2lVKUGXlabr022TqU2n1GN4uTh2Rr\"\
,\n \"kid\": \"5k1qe9KiuNeerXfakqtOyrIT12gm5x_3hPDNkcvSD_w\",\n \"use\": \"sig\",\n \
\ \"alg\": \"ES512\"\n }\n ],\n \"isDeleted\": false,\n \"createdAt\": \"2024-06-27T18:06:17.084042-03:00\"\
,\n \"updatedAt\": \"2024-06-27T18:06:17.084067-03:00\"\n}"
_postman_id: 84d8684c-edc5-4a06-b943-cde52efb9a2a
- name: Generate Authorization Token
event:
- listen: prerequest
script:
id: b282df3d-08f7-4a2d-bc2f-e1d30a5fa803
exec:
- 'var navigator = { userAgent: "PostmanRuntime" };'
- 'var window = { navigator: navigator };'
- ''
- function uuidv4() {
- ' return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {'
- ' var r = (Math.random() * 16) | 0;'
- ' var v = c === "x" ? r : (r & 0x3) | 0x8;'
- ' return v.toString(16);'
- ' });'
- '}'
- ''
- var jsrsasignJs = pm.collectionVariables.get("jsrsasign-js");
- if (!jsrsasignJs) {
- ' throw new Error(''Rode primeiro o request "Bootstrap jsrsasign" para popular jsrsasign-js.'');'
- '}'
- ''
- eval(jsrsasignJs);
- ''
- if (typeof KJUR === "undefined") {
- ' throw new Error("KJUR não carregou. Apague jsrsasign-js e rode o Bootstrap de novo.");'
- '}'
- ''
- var clientId = pm.environment.get("client_api_id");
- var audienceTemplate = pm.environment.get("audience");
- var privateKey = pm.environment.get("jwt_secret");
- ''
- if (!clientId) throw new Error("Defina client_api_id na environment.");
- if (!audienceTemplate) throw new Error("Defina audience na environment.");
- if (!privateKey) throw new Error("Defina jwt_secret na environment.");
- ''
- var aud = pm.variables.replaceIn(audienceTemplate);
- privateKey = privateKey.replace(/\\n/g, "\n");
- ''
- var now = Math.floor(Date.now() / 1000);
- 'var header = { alg: "ES512", typ: "JWT" };'
- var payload = {
- ' iat: now,'
- ' exp: now + 300,'
- ' aud: aud,'
- ' iss: clientId,'
- ' sub: clientId,'
- ' jti: uuidv4(),'
- '};'
- ''
- var jwtSigned = KJUR.jws.JWS.sign(null, header, payload, privateKey, null);
- ''
- pm.environment.set("jwt_signed", jwtSigned);
- console.log("jwt_signed OK | client:", clientId);
type: text/javascript
packages: {}
requests: {}
- listen: test
script:
id: 51c9da81-c218-4461-a42e-5d11fed73b34
exec:
- pm.test("Should return the token", function () {
- ' var jsonData = pm.response.json();'
- ' pm.expect(jsonData.accessToken).length.to.be.gte(40);'
- ' pm.environment.set("access_token", jsonData.accessToken);'
- '});'
type: text/javascript
packages: {}
requests: {}
id: 8840f11e-7878-431d-86d3-0c21a73a4999
protocolProfileBehavior:
disableBodyPruning: true
request:
method: POST
header: []
body:
mode: raw
raw: '{"clientId": "{{client_api_id}}", "clientAssertion": "{{jwt_signed}}"}'
options:
raw:
language: json
url: '{{base_url}}/api/v1/auth/token'
description: "<p>The <strong>clientId</strong> will be sent to the integrator during the initial setup.</p>\n<p>The\
\ <strong>clientAssertion</strong> will be generated in the pre-request script, but we also have this example below\
\ in PHP if you want create by yourself.</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"\
language-php\">$secretKey = 'YOUR_PRIVATE_KEY';\n$alg = 'ES512';\n$payload = [\n 'iat' => Carbon::now()->timestamp,\n\
\ 'exp' => Carbon::now()->addDay()->timestamp,\n 'aud' => 'https://auth.kanastra.com.br/realms/{{realm_name}}/protocol/openid-connect/token',\n\
\ 'iss' => 'your-client-id',\n 'sub' => 'your-client-id',\n 'jti' => Uuid::uuid4()->toString(),\n\
];\n$jwt_signed = JWT::encode($payload, $secretKey, $alg);\n\n</code></pre>\n<p>You should be authenticated after\
\ this steps, the post-request script will set the access_token on every api call, and if you have the scope permission\
\ to use you be able to test it.</p>\n"
urlObject:
path:
- api
- v1
- auth
- token
host:
- '{{base_url}}'
query: []
variable: []
response:
- id: 2ff13683-77f7-4789-99a7-4b6d98177da9
name: OK
originalRequest:
method: POST
header: []
body:
mode: raw
raw: "{\n \"client_id\": \"client_id\",\n \"client_assertion\": \"eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6ImxNdEc3NWJLazJvdmhXaVFxVjBpYnRtQW1WY3VUenBNN1R4SWRWQUYyOTQifQ.eyJpYXQiOjE3MTE5ODkzMzcsImV4cCI6MTk3MTE4OTMzNywiYXVkIjoiaHR0cHM6Ly9rZXljbG9hay5rYW5hc3RyYS5kZXYvcmVhbG1zL3RlY2gtaHViL3Byb3RvY29sL29wZW5pZC1jb25uZWN0L3Rva2VuIiwiaXNzIjoidGVjaC1odWItY2xpZW50Iiwic3ViIjoidGVjaC1odWItY2xpZW50IiwianRpIjoiMmY2ODA1YmItNThjMC00OWVkLWFjOTEtN2NkODA3ZTgzZTViIn0.AX51Z0y4oZFhLTgMBUCptkcM1C-LE4Y23Uc-9RO1xi3yPweatjhKVGT9e6vEsOZG_JW3tQ4nu97YH8wRtyeqGAczAU0b_ry803Z2UbrPpFTfTuMjUeFi6oqfw6bgrkPLkIjSsRq2M493PJlJPxpZyrZBYVHjzNqpvRm9c3D_N-DMfMtu\"\
\n}"
options:
raw:
language: json
url: https://banking-sandbox.kanastra.com.br/api/v1/auth/token
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
description: ''
type: text
cookie: []
responseTime: null
body: "{\n \"accessToken\": \"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtb0JQbndkcmRzamQ0alRJNmZqenZMdG1mb3Q4MUJhM2dId19rNjhDRmNBIn0.eyJleHAiOjE3MTIwMjUzMzgsImlhdCI6MTcxMTk4OTMzOSwianRpIjoiOGQyNjJkOWYtMWEyYi00MjRjLTkzMTItNmU2MzhmNWI3MDkwIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5rYW5hc3RyYS5kZXYvcmVhbG1zL3RlY2gtaHViIiwic3ViIjoiZDM3YzE5YTQtNTIzOS00MTYyLThlZjgtNTMxMmNkY2IzYmYxIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoidGVjaC1odWItY2xpZW50Iiwic2NvcGUiOiJ3ZWJob29rIGJhbmtfc2xpcCBiYW5rX3NsaXA6Y3JlYXRlIGZpbmFuY2lhbF9hY2NvdW50IGNvbW1lcmNpYWxfcGFwZXIiLCJjbGllbnRIb3N0IjoiMTAuMTMwLjEzLjIzNyIsIm9yaWdpbmF0b3JfaWQiOiI3NGU2ZjdjZi02MTA5LTRmZTktODk4Yy04OGRiNjBmZGE4ZWIiLCJjbGllbnRBZGRyZXNzIjoiMTAuMTMwLjEzLjIzNyIsImNsaWVudF9pZCI6InRlY2gtaHViLWNsaWVudCJ9.vBP35w7Lsz_sE4J10rrui5VT_MKkJe4toN8H7iP15hzOSGYAdpWGvJqHP3jiT5EGpdrwbuexQnbHcdAdIjYmM8dExwkYM2X1menlvSBJ4dEugRi1KJyrgJvPVzBlF2mtHsJNYJ3zc2FK3aG2KwZhnc0OLHFCGJhysJAEjhH3iDrPf-SBolCFHqznD5f1MVFgctb28xjyaYnD6WFnHT4U61T9H0z_BZ9l8SvdusdQcQI7EYw0eAPUgd5SNhdWXxMVwC-px-2x_dS8WbC4nbVMdqsaKO8ZCbcwqjOh6QUh-6woy7Tl9rsnCUWM9ODdFOjM3aejHbEdL6eCAoVLGy0x3A\"\
,\n \"expiresIn\": 35999,\n \"refreshExpiresIn\": 0,\n \"tokenType\": \"Bearer\",\n \"not-before-policy\"\
: 0,\n \"scope\": \"webhook bank_slip bank_slip:create financial_account commercial_paper\"\n}"
_postman_id: 8840f11e-7878-431d-86d3-0c21a73a4999
id: 39f233a8-04ac-4847-8bc0-9e46f68e4e2c
description: '<p>To authenticate with our services, will provide you an <strong>clientId</strong> and <strong>Realm name.</strong></p>
'
_postman_id: 39f233a8-04ac-4847-8bc0-9e46f68e4e2c
- name: Bank Slip (Boleto)
item:
- name: Wallet
item:
- name: List
id: 5be5257e-7af4-4b1d-9cc6-abd9d2690a0d
protocolProfileBehavior:
disableBodyPruning: true
request:
auth:
type: bearer
bearer:
basicConfig:
- key: token
value: '{{access_token}}'
isInherited: false
method: GET
header:
- key: client-id
value: '{{client_id}}'
type: text
url: '{{base_url}}/api/v1/wallets'
description: '<p>Get a list of all the wallets for the authenticated user.</p>
'
urlObject:
path:
- api
- v1
- wallets
host:
- '{{base_url}}'
query: []
variable: []
response:
- id: 19ee7b34-a622-45ac-8e7c-1ed021ea5078
name: OK List
originalRequest:
method: GET
header:
- key: client-id
value: tech-hub-client
type: text
url: https://banking-sandbox.kanastra.com.br/api/v1/wallets
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Date
value: Thu, 27 Jun 2024 21:23:36 GMT
- key: Content-Type
value: application/json
- key: Content-Length
value: '541'
- key: Connection
value: keep-alive
- key: vary
value: Accept, origin, Cookie, Accept-Encoding
- key: allow
value: GET, POST, HEAD, OPTIONS
- key: x-frame-options
value: DENY
- key: content-encoding
value: gzip
- key: x-content-type-options
value: nosniff
- key: referrer-policy
value: no-referrer-when-downgrade
- key: cross-origin-opener-policy
value: same-origin
- key: x-request-id
value: cd29b362a4373c4f8a3e4474dcc15695
- key: Strict-Transport-Security
value: max-age=63072000; includeSubDomains; preload
- key: CF-Cache-Status
value: DYNAMIC
- key: Report-To
value: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=nE0ghPQYPGfQVa%2FIY6PS46Jgtd9ZDltCX2aUnrwdJFb%2BZSQQgtR6m0bcFpHwaVosEavG7GLrpmehWoPjvrU3dJxdEcLBDAwk4ooLSmaP5gkYQDWX2hOZQTjXfnNJ5lDOVJ7Bdkv3paCASB6Btxpv8Uc5"}],"group":"cf-nel","max_age":604800}'
- key: NEL
value: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
- key: Server
value: cloudflare
- key: CF-RAY
value: 89a87fc47fee011a-GRU
- key: alt-svc
value: h3=":443"; ma=86400
cookie: []
responseTime: null
body: "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \
\ \"uuid\": \"452915ca-94fc-4d97-a262-cf944bb62145\",\n \"name\": \"Wallet Demonstração\",\n \
\ \"code\": 100,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\"\
,\n \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\"\
,\n \"accountDigit\": \"0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\"\
: \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\",\n \"updatedAt\"\
: \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \
\ \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\"\
,\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\"\
: \"32276572000194\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n\
\ \"agency\": \"0001\",\n \"account\": \"5833963\",\n \
\ \"digit\": \"5\",\n \"isFavorite\": true,\n \"bankCode\"\
: 559\n }\n ]\n },\n \"acceptPartialPayment\": false\n \
\ }\n ]\n}"
_postman_id: 5be5257e-7af4-4b1d-9cc6-abd9d2690a0d
- name: List Copy
id: c3ad4c9f-668d-4824-a99f-fb1fd6a7d89b
protocolProfileBehavior:
disableBodyPruning: true
request:
auth:
type: bearer
bearer:
basicConfig:
- key: token
value: '{{access_token}}'
isInherited: false
method: GET
header:
- key: client-id
value: '{{client_id}}'
type: text
url: '{{base_url}}/api/v1/wallets'
description: '<p>Get a list of all the wallets for the authenticated user.</p>
'
urlObject:
path:
- api
- v1
- wallets
host:
- '{{base_url}}'
query: []
variable: []
response:
- id: 1125006f-ad4e-4647-8e49-04e679c7b2f2
name: OK List
originalRequest:
method: GET
header:
- key: client-id
value: tech-hub-client
type: text
url: https://banking-sandbox.kanastra.com.br/api/v1/wallets
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Date
value: Thu, 27 Jun 2024 21:23:36 GMT
- key: Content-Type
value: application/json
- key: Content-Length
value: '541'
- key: Connection
value: keep-alive
- key: vary
value: Accept, origin, Cookie, Accept-Encoding
- key: allow
value: GET, POST, HEAD, OPTIONS
- key: x-frame-options
value: DENY
- key: content-encoding
value: gzip
- key: x-content-type-options
value: nosniff
- key: referrer-policy
value: no-referrer-when-downgrade
- key: cross-origin-opener-policy
value: same-origin
- key: x-request-id
value: cd29b362a4373c4f8a3e4474dcc15695
- key: Strict-Transport-Security
value: max-age=63072000; includeSubDomains; preload
- key: CF-Cache-Status
value: DYNAMIC
- key: Report-To
value: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=nE0ghPQYPGfQVa%2FIY6PS46Jgtd9ZDltCX2aUnrwdJFb%2BZSQQgtR6m0bcFpHwaVosEavG7GLrpmehWoPjvrU3dJxdEcLBDAwk4ooLSmaP5gkYQDWX2hOZQTjXfnNJ5lDOVJ7Bdkv3paCASB6Btxpv8Uc5"}],"group":"cf-nel","max_age":604800}'
- key: NEL
value: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
- key: Server
value: cloudflare
- key: CF-RAY
value: 89a87fc47fee011a-GRU
- key: alt-svc
value: h3=":443"; ma=86400
cookie: []
responseTime: null
body: "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \
\ \"uuid\": \"452915ca-94fc-4d97-a262-cf944bb62145\",\n \"name\": \"Wallet Demonstração\",\n \
\ \"code\": 100,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\"\
,\n \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\"\
,\n \"accountDigit\": \"0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\"\
: \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\",\n \"updatedAt\"\
: \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\",\n \
\ \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\"\
,\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\"\
: \"32276572000194\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n\
\ \"agency\": \"0001\",\n \"account\": \"5833963\",\n \
\ \"digit\": \"5\",\n \"isFavorite\": true,\n \"bankCode\"\
: 559\n }\n ]\n },\n \"acceptPartialPayment\": false\n \
\ }\n ]\n}"
_postman_id: c3ad4c9f-668d-4824-a99f-fb1fd6a7d89b
- name: Retrieve
id: 6a3809dd-8e4e-4600-8992-dae9a6efda57
protocolProfileBehavior:
disableBodyPruning: true
request:
auth:
type: bearer
bearer:
basicConfig:
- key: token
value: '{{access_token}}'
isInherited: false
method: GET
header:
- key: client-id
value: '{{client_id}}'
type: text
url: '{{base_url}}/api/v1/wallets/:wallet_id'
description: '<p>Retrieves detailed information about a specific wallet identified by its unique ID.</p>
'
urlObject:
path:
- api
- v1
- wallets
- :wallet_id
host:
- '{{base_url}}'
query: []
variable:
- type: any
value: 452915ca-94fc-4d97-a262-cf944bb62145
key: wallet_id
response:
- id: 2494c39b-cd35-4055-87ae-a5acfbe536f3
name: OK Retrieve
originalRequest:
method: GET
header:
- key: client-id
value: tech-hub-client
type: text
url:
raw: https://banking-sandbox.kanastra.com.br/api/v1/wallets/:wallet_id
protocol: https
host:
- banking-sandbox
- kanastra
- com
- br
path:
- api
- v1
- wallets
- :wallet_id
variable:
- key: wallet_id
value: 452915ca-94fc-4d97-a262-cf944bb62145
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Date
value: Thu, 27 Jun 2024 21:24:20 GMT
- key: Content-Type
value: application/json
- key: Content-Length
value: '494'
- key: Connection
value: keep-alive
- key: vary
value: Accept, origin, Cookie, Accept-Encoding
- key: allow
value: GET, PUT, HEAD, OPTIONS
- key: x-frame-options
value: DENY
- key: content-encoding
value: gzip
- key: x-content-type-options
value: nosniff
- key: referrer-policy
value: no-referrer-when-downgrade
- key: cross-origin-opener-policy
value: same-origin
- key: x-request-id
value: e201686d7e81c4536dbdbae65e00140c
- key: Strict-Transport-Security
value: max-age=63072000; includeSubDomains; preload
- key: CF-Cache-Status
value: DYNAMIC
- key: Report-To
value: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=7574YIL2YrFyrTdYqPGO2rpwJ49IcDeBg760IsYeXANUEaj%2Bq06ZOKYKDwArK%2FePlQ%2FxwhjOZg8hpNedM3nXiGSQxp%2Bv6Ki9LYcJpRtXIMubLpVcREhJL2t%2Bj8Dgsvt2hVBPzxilX3eWAdXS%2Bk5IgxDw"}],"group":"cf-nel","max_age":604800}'
- key: NEL
value: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
- key: Server
value: cloudflare
- key: CF-RAY
value: 89a880d47bbd011a-GRU
- key: alt-svc
value: h3=":443"; ma=86400
cookie: []
responseTime: null
body: "{\n \"uuid\": \"452915ca-94fc-4d97-a262-cf944bb62145\",\n \"name\": \"Wallet Demonstração\",\n \"\
code\": 100,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \
\ \"isDeleted\": false,\n \"branch\": \"1\",\n \"account\": \"93\",\n \"accountDigit\": \"\
0\",\n \"type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\"\
,\n \"updatedAt\": \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\"\
,\n \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\"\
,\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\"\
,\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"agency\":\
\ \"0001\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\"\
: true,\n \"bankCode\": 559\n }\n ]\n },\n \"acceptPartialPayment\": false\n\
}"
_postman_id: 6a3809dd-8e4e-4600-8992-dae9a6efda57
- name: Create
id: d8095c62-04a0-4ee1-b247-f672028cd440
protocolProfileBehavior:
disableBodyPruning: true
request:
auth:
type: bearer
bearer:
basicConfig:
- key: token
value: '{{access_token}}'
isInherited: false
method: POST
header:
- key: client-id
value: '{{client_id}}'
type: text
body:
mode: raw
raw: "{\n \"name\": \"Test Wallet 5\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n\
\ \"code\": 106,\n \"acceptPartialPayment\": true\n}"
options:
raw:
language: json
url: '{{base_url}}/api/v1/wallets'
description: '<p>You can create a new wallet with this endpoint.</p>
<p><strong>Parameters</strong>:</p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Field name</strong></th>
<th><strong>Description</strong></th>
<th><strong>Validation</strong></th>
<th><strong>Type</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>name</code></td>
<td>Wallet name</td>
<td>Required, must be a non-empty string</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>financial_account</code></td>
<td>ID of the financial account to which the wallet is linked</td>
<td>Required</td>
<td><code>string</code></td>
</tr>
<tr>
<td><code>code</code></td>
<td>Wallet code</td>
<td>Required, maximum of 3 digits</td>
<td><code>integer</code></td>
</tr>
<tr>
<td><code>accept_partial_payment</code></td>
<td>Indicates whether bank slips in this wallet can be paid partially</td>
<td>Not required, defaults to false</td>
<td><code>boolean</code></td>
</tr>
</tbody>
</table>
</div>'
urlObject:
path:
- api
- v1
- wallets
host:
- '{{base_url}}'
query: []
variable: []
response:
- id: 87be8790-912c-4345-a82c-df9593c827e5
name: OK Create
originalRequest:
method: POST
header:
- key: client-id
value: tech-hub-client
type: text
body:
mode: raw
raw: "{\n \"name\": \"Test Wallet 5\",\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\"\
,\n \"code\": 106,\n \"acceptPartialPayment\": true\n}"
options:
raw:
language: json
url: https://banking-sandbox.kanastra.com.br/api/v1/wallets
status: Created
code: 201
_postman_previewlanguage: json
header:
- key: Date
value: Thu, 27 Jun 2024 23:57:22 GMT
- key: Content-Type
value: application/json
- key: Content-Length
value: '480'
- key: Connection
value: keep-alive
- key: vary
value: Accept, origin, Cookie, Accept-Encoding
- key: allow
value: GET, POST, HEAD, OPTIONS
- key: x-frame-options
value: DENY
- key: content-encoding
value: gzip
- key: x-content-type-options
value: nosniff
- key: referrer-policy
value: no-referrer-when-downgrade
- key: cross-origin-opener-policy
value: same-origin
- key: x-request-id
value: 6fbdc0973c2b368ca81ad5f02c0fa338
- key: Strict-Transport-Security
value: max-age=63072000; includeSubDomains; preload
- key: CF-Cache-Status
value: DYNAMIC
- key: Report-To
value: '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=aL93B78hb%2BzjHld85sDlmFEaMCV9Dun2nzJ%2FiUeTz9V4c12h9tBPQ5rkb6CDk7E3hfQtowU6FUkuOCRRs6sTnddSg8y%2BDIpB%2FXHDiKrbGtbtVzCMpKCidy3Lqzbywv8IvC7etbntmKknpWrbx8UuXPL4"}],"group":"cf-nel","max_age":604800}'
- key: NEL
value: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
- key: Server
value: cloudflare
- key: CF-RAY
value: 89a9610488d21aa4-GRU
- key: alt-svc
value: h3=":443"; ma=86400
cookie: []
responseTime: null
body: "{\n \"uuid\": \"34851df9-4022-47a6-a6d6-b28829c0db75\",\n \"name\": \"Test Wallet 5\",\n \"code\"\
: 106,\n \"financialAccount\": {\n \"uuid\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"isDeleted\"\
: false,\n \"branch\": \"1\",\n \"account\": \"93\",\n \"accountDigit\": \"0\",\n \"\
type\": \"LINKED_ACCOUNT\",\n \"status\": \"ACTIVE\",\n \"createdAt\": \"2024-06-20T09:58:21.994394-03:00\"\
,\n \"updatedAt\": \"2024-06-26T16:38:32.147974-03:00\",\n \"institution\": \"559 - Kanastra SCD\"\
,\n \"beneficiaryBankAccounts\": [\n {\n \"uuid\": \"8bb41c11-6878-4994-929b-3317c349d5a8\"\
,\n \"holderName\": \"Beneficiário Demonstração\",\n \"governmentId\": \"32276572000194\"\
,\n \"financialAccount\": \"bd56f332-07d4-453b-8338-eaae0b3ede64\",\n \"agency\":\
\ \"0001\",\n \"account\": \"5833963\",\n \"digit\": \"5\",\n \"isFavorite\"\
: true,\n \"bankCode\": 559\n }\n ]\n },\n \"acceptPartialPayment\": true\n\
}"
_postman_id: d8095c62-04a0-4ee1-b247-f672028cd440
- name: Update
id: 1ca4a2a6-cd47-4111-9391-2757d82320bc
protocolProfileBehavior:
disableBodyPruning: true
request:
auth:
type: bearer
bearer:
basicConfig:
- key: token
value: '{{access_token}}'
isInherited: false
method: PUT
header:
- key: client-id
value: '{{client_id}}'
type: text
body:
mode: raw
raw: "{\n \"name\": \"Test Wallet Atualizada\",\n \"financial_account\": \"ea01e909-1c43-44bc-94d7-5cdeac0ef181\"\
,\n \"code\": 562,\n \"accept_partial_payment\": false\n}"
options:
raw:
language: json
url: '{{base_url}}/api/v1/wallets/:wallet_id'
description: '<p>Updates an existing wallet by its unique ID based on the data provided in the request</p>
<p><strong>Parameters</strong></p>
<div class="click-to-expand-wrapper is-table-wrapper"><table>
<thead>
<tr>
<th><strong>Field name</st
# --- truncated at 32 KB (1179 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kanastra/refs/heads/main/apis.yml