Update a wallet

curl --request PUT \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Marketing e eventos",
  "customFields": {
    "cost-center": "CC-1020"
  },
  "settings": {
    "payment": {
      "pix": true,
      "bankSlip": false,
      "card": true
    }
  },
  "shared": [
    {
      "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
      "role": "OWNER"
    }
  ]
}
'

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}"

payload = {
    "name": "Marketing e eventos",
    "customFields": { "cost-center": "CC-1020" },
    "settings": { "payment": {
            "pix": True,
            "bankSlip": False,
            "card": True
        } },
    "shared": [
        {
            "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
            "role": "OWNER"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Marketing e eventos',
    customFields: {'cost-center': 'CC-1020'},
    settings: {payment: {pix: true, bankSlip: false, card: true}},
    shared: [{id: 'e3553bc1-5e20-4e17-b22a-a796fda0aa99', role: 'OWNER'}]
  })
};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Marketing e eventos',
    'customFields' => [
        'cost-center' => 'CC-1020'
    ],
    'settings' => [
        'payment' => [
                'pix' => true,
                'bankSlip' => false,
                'card' => true
        ]
    ],
    'shared' => [
        [
                'id' => 'e3553bc1-5e20-4e17-b22a-a796fda0aa99',
                'role' => 'OWNER'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}"

	payload := strings.NewReader("{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "66f2a3d1b4d3e80012c9a0d2",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "environment": "LIVE",
  "currency": "986",
  "status": "ACTIVE",
  "role": "CHECKING",
  "type": "SHARED",
  "shared": [
    {
      "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
      "role": "OWNER",
      "_id": "66f2a3d1b4d3e80012c9a0d3",
      "firstName": "Mariana",
      "lastName": "Costa",
      "email": "mariana.costa@acme.com.br"
    }
  ],
  "isSuper": false,
  "createdAt": "2024-10-01T12:30:05.000Z",
  "updatedAt": "2024-10-01T12:34:41.000Z",
  "external": {
    "balanceAccountGroupId": "4f6b0e1d-2b3a-4c5d-8e9f-0a1b2c3d4e5f",
    "accountNumber": 10023456,
    "branch": "0001",
    "accountType": "PREPAID"
  },
  "customFields": {
    "cost-center": "CC-1020"
  },
  "name": "Marketing",
  "settings": {
    "payment": {
      "pix": true,
      "bankSlip": true,
      "card": true
    },
    "notification": {
      "balanceLimit": {
        "amount": 50000,
        "email": true,
        "isActive": true
      }
    }
  },
  "walletProduct": "NORMAL",
  "createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
  "updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
  "accountType": "PREPAID",
  "__v": 0
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "FORBIDDEN_WALLET",
  "origin": "BANKING",
  "message": "You do not have permission to perform this action on this wallet"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

PUT

realms

{realmId}

organizations

{organizationId}

accounts

{accountId}

wallets

{walletId}

Update a wallet

curl --request PUT \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Marketing e eventos",
  "customFields": {
    "cost-center": "CC-1020"
  },
  "settings": {
    "payment": {
      "pix": true,
      "bankSlip": false,
      "card": true
    }
  },
  "shared": [
    {
      "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
      "role": "OWNER"
    }
  ]
}
'

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}"

payload = {
    "name": "Marketing e eventos",
    "customFields": { "cost-center": "CC-1020" },
    "settings": { "payment": {
            "pix": True,
            "bankSlip": False,
            "card": True
        } },
    "shared": [
        {
            "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
            "role": "OWNER"
        }
    ]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Marketing e eventos',
    customFields: {'cost-center': 'CC-1020'},
    settings: {payment: {pix: true, bankSlip: false, card: true}},
    shared: [{id: 'e3553bc1-5e20-4e17-b22a-a796fda0aa99', role: 'OWNER'}]
  })
};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Marketing e eventos',
    'customFields' => [
        'cost-center' => 'CC-1020'
    ],
    'settings' => [
        'payment' => [
                'pix' => true,
                'bankSlip' => false,
                'card' => true
        ]
    ],
    'shared' => [
        [
                'id' => 'e3553bc1-5e20-4e17-b22a-a796fda0aa99',
                'role' => 'OWNER'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}"

	payload := strings.NewReader("{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Marketing e eventos\",\n  \"customFields\": {\n    \"cost-center\": \"CC-1020\"\n  },\n  \"settings\": {\n    \"payment\": {\n      \"pix\": true,\n      \"bankSlip\": false,\n      \"card\": true\n    }\n  },\n  \"shared\": [\n    {\n      \"id\": \"e3553bc1-5e20-4e17-b22a-a796fda0aa99\",\n      \"role\": \"OWNER\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "_id": "66f2a3d1b4d3e80012c9a0d2",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "environment": "LIVE",
  "currency": "986",
  "status": "ACTIVE",
  "role": "CHECKING",
  "type": "SHARED",
  "shared": [
    {
      "id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
      "role": "OWNER",
      "_id": "66f2a3d1b4d3e80012c9a0d3",
      "firstName": "Mariana",
      "lastName": "Costa",
      "email": "mariana.costa@acme.com.br"
    }
  ],
  "isSuper": false,
  "createdAt": "2024-10-01T12:30:05.000Z",
  "updatedAt": "2024-10-01T12:34:41.000Z",
  "external": {
    "balanceAccountGroupId": "4f6b0e1d-2b3a-4c5d-8e9f-0a1b2c3d4e5f",
    "accountNumber": 10023456,
    "branch": "0001",
    "accountType": "PREPAID"
  },
  "customFields": {
    "cost-center": "CC-1020"
  },
  "name": "Marketing",
  "settings": {
    "payment": {
      "pix": true,
      "bankSlip": true,
      "card": true
    },
    "notification": {
      "balanceLimit": {
        "amount": 50000,
        "email": true,
        "isActive": true
      }
    }
  },
  "walletProduct": "NORMAL",
  "createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
  "updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
  "accountType": "PREPAID",
  "__v": 0
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "FORBIDDEN_WALLET",
  "origin": "BANKING",
  "message": "You do not have permission to perform this action on this wallet"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

Send only what you change. shared replaces the whole list of users: at least one must be an OWNER who is a member of the organization, and users who aren’t members are left out. customFields replaces every value the wallet has. In settings.payment, each method you leave out keeps its current setting. The organization’s main wallet (ORGANIZATION) can’t be edited here. Organization admins can edit every wallet; other users only the wallets shared with them as OWNER or USER.

Headers

x-environment

enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.

Available options:

LIVE,

TEST

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization the wallet belongs to.

Format: UUID

accountId

string

required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

walletId

string

required

ID of the wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

Body

application/json

name

string

New name of the wallet. An empty name keeps the current one.

Example:

"Marketing e eventos"

customFields

object

Values of the organization's wallet custom fields, keyed by each field's slug. Replaces every value the wallet has; omit it to keep them.

Example: {"cost-center":"CC-1020"}

Show child attributes

Example:

{ "cost-center": "CC-1020" }

settings

object

Settings to change. Omit it to keep the current ones.

Show child attributes

shared

object[]

Users who can use the wallet, and how. Replaces the whole list; at least one must be an OWNER who is a member of the organization, and users who aren't members are left out. Omit it to keep the current users.

Minimum array length: 1

Show child attributes

Response

Successful response

A wallet: a balance of the organization's account, with its own bank account details, cards and PIX keys, shared with the users who can use it.

_id

string

required

ID of the wallet.

Example:

"66f2a3d1b4d3e80012c9a0d2"

realmId

string<uuid>

required

ID of the realm the wallet belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId

string<uuid>

required

ID of the organization the wallet belongs to.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

accountId

string

required

ID of the account the wallet belongs to.

Example:

"66f2a1c7b4d3e80012c9a0b4"

environment

enum<string>

required

Environment the wallet lives in: LIVE (production) or TEST (sandbox).

Available options:

LIVE,

TEST

Example:

"LIVE"

currency

string

required

Currency of the wallet, as an ISO 4217 numeric code. Always 986 (Brazilian real).

Example:

"986"

status

enum<string>

required

Status of the wallet: PENDING (being created — it can't move money yet), ACTIVE, BLOCKED (it can't move money until it is unblocked), CANCELLING or CANCELLED (closed), REPROVED (its creation was refused), FRAUD_ANALYSIS (on hold while suspected fraud is analyzed) or FRAUD_CONFIRMED (closed for fraud).

Available options:

PENDING,

ACTIVE,

CANCELLING,

CANCELLED,

BLOCKED,

REPROVED,

FRAUD_ANALYSIS,

FRAUD_CONFIRMED

Example:

"ACTIVE"

role

string

required

Role of the wallet in the account: DEFAULT for the organization's main wallet — the one that funds and receives the other wallets' transfers — and CHECKING for every other wallet. A few older wallets carry another value.

Example:

"CHECKING"

type

enum<string>

required

Kind of wallet: ORGANIZATION (the organization's main wallet), SHARED (used by a team), PERSONAL (a single user's) or VEHICLE (a vehicle's, for its fuel and other purchases).

Available options:

PERSONAL,

SHARED,

ORGANIZATION,

VEHICLE

Example:

"SHARED"

shared

object[]

required

Users who can use the wallet, and how. Organization admins can use every wallet.

Show child attributes

isSuper

boolean

required

Whether the wallet's cards are on the premium card product.

Example:

false

createdAt

string<date-time>

required

When the wallet was created.

Example:

"2024-10-01T12:30:05.000Z"

updatedAt

string<date-time>

required

When the wallet last changed.

Example:

"2024-10-01T12:34:41.000Z"

external

object

The wallet's bank account. Absent on a few wallets created before it was recorded.

Show child attributes

customFields

object

Values of the organization's wallet custom fields, keyed by each field's slug. Absent when the wallet has none.

Example: {"cost-center":"CC-1020"}

Show child attributes

Example:

{ "cost-center": "CC-1020" }

name

string | null

Name of the wallet. Absent on older wallets created without one.

Example:

"Marketing"

settings

object

Settings of the wallet. Absent on older wallets created without them.

Show child attributes

walletProduct

string

Card product of the wallet, inherited from the account. Absent on older wallets.

Example:

"NORMAL"

createdBy

string<uuid> | null

ID of the user who created the wallet. Absent, or null, on older wallets.

Example:

"e3553bc1-5e20-4e17-b22a-a796fda0aa99"

updatedBy

string<uuid> | null

ID of the user who created the wallet; editing it doesn't change this field. Absent, or null, on older wallets.

Example:

"e3553bc1-5e20-4e17-b22a-a796fda0aa99"

accountType

enum<string>

Type of the wallet's bank account, on older wallets only: the same as external.accountType.

Available options:

PREPAID,

CCLG

Example:

"PREPAID"

__v

number

Internal revision counter of the wallet.

Example:

0

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Update a wallet

Headers

Path Parameters

Body

Response