{ "openapi": "3.1.0", "info": { "title": "Brighty API", "version": "1.0.0" }, "servers": [ { "url": "https://api.brighty.app", "description": "Brighty API (Live)" }, { "url": "https://api.brighty.codes", "description": "Brighty API (Sandbox)" } ], "paths": { "/business/v1/payouts": { "get": { "tags": [ "Payout" ], "summary": "Get created payouts", "description": "Get created payouts", "parameters": [], "responses": { "200": { "description": "A list of payouts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayoutsResponse" }, "examples": { "Example": { "payouts": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Payroll", "description": "Monthly payroll", "state": "CREATED", "createdAt": "2021-12-31T23:59:59.111Z", "startedAt": "2021-12-31T23:59:59.111Z", "totalTransfers": 10, "paidTransfers": 5, "totalAmount": { "amount": "100.00", "currency": "USDT" }, "paidAmount": { "amount": "50.00", "currency": "USD" } } ], "nextPage": "MjAyMy0wMi0yOFQxNDozMzoyMS4yOThafGRlZmF1bHQ=" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] }, "post": { "tags": [ "Payout" ], "summary": "Create a new payout", "description": "Create a new payout", "parameters": [], "requestBody": { "description": "The payout to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutCreateRequest" }, "examples": { "Example": { "name": "Payroll", "description": "Payroll for 12/2024" } } } }, "required": true }, "responses": { "201": { "description": "The created payout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PubApiPayoutPayout" }, "examples": { "Example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Payroll", "description": "Monthly payroll", "state": "CREATED", "createdAt": "2021-12-31T23:59:59.111Z", "startedAt": "2021-12-31T23:59:59.111Z", "totalTransfers": 10, "paidTransfers": 5, "totalAmount": { "amount": "100.00", "currency": "USDT" }, "paidAmount": { "amount": "50.00", "currency": "USD" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/payouts/{id}": { "get": { "tags": [ "Payout" ], "summary": "Get payout by id", "description": "Get payout by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Payout's id", "required": true, "deprecated": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "description": "Payout's createdAt date and time", "required": true, "deprecated": false } ], "responses": { "200": { "description": "The payout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPayoutResponse" }, "examples": { "Example": { "payout": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Payroll", "description": "Monthly payroll", "state": "CREATED", "createdAt": "2021-12-31T23:59:59.111Z", "startedAt": "2021-12-31T23:59:59.111Z", "totalTransfers": 10, "paidTransfers": 5, "totalAmount": { "amount": "100.00", "currency": "USDT" }, "paidAmount": { "amount": "50.00", "currency": "USD" } }, "transfers": [ { "type": "Crypto", "id": "300cf317-3b89-45cf-b07a-803e7834815b", "status": "PENDING", "createdAt": "2021-12-31T23:59:59.111Z", "amount": { "amount": "10.00", "currency": "USDT" }, "amountWithFee": { "amount": "10.10", "currency": "USDT" }, "totalFee": { "amount": "0.10", "currency": "USDT" }, "fromAccount": { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "name": "USDT Account", "balance": { "amount": "100.00", "currency": "USDT" } }, "toAccount": { "id": "a13f842d-db62-4741-8d73-f1f6f143df18", "address": "0x1234567890abcdef", "network": "TRC20", "name": "Alice's Wallet" }, "reference": "Salary" } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] }, "patch": { "tags": [ "Payout" ], "summary": "Update payout by id", "description": "Update payout by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Payout's id", "required": true, "deprecated": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "description": "Payout's createdAt date and time", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutUpdateRequest" }, "examples": { "Example": { "name": "Payroll", "description": "Monthly payroll" } } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/payouts/{id}/start": { "post": { "tags": [ "Payout" ], "summary": "Start payout's transfers", "description": "Start payout's transfers", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Payout's id", "required": true, "deprecated": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "description": "Payout's createdAt date and time", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/payouts/{id}/transfers/internal": { "post": { "tags": [ "Payout" ], "summary": "Create Brighty transfer", "description": "Create Brighty transfer", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Payout's id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferCreateRequest" }, "examples": { "Example": { "sourceAccountId": "a893ad17-065d-493b-99d2-d3723e692360", "receiverUsername": "jon_doe", "amount": { "amount": "10.00", "currency": "USDT" }, "comment": "Salary" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferPostponedResponse" }, "examples": { "Example": { "id": "300cf317-3b89-45cf-b07a-803e7834815b", "createdAt": "2021-12-31T23:59:59.111Z" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/payouts/{id}/transfers/external": { "post": { "tags": [ "Payout" ], "summary": "Create fiat/crypto transfer", "description": "Create fiat/crypto transfer", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Payout's id", "required": true, "deprecated": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "description": "Payout's createdAt date and time", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTransferCreateRequest" }, "examples": { "Example": { "sourceAccountId": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "beneficiary": { "accountNumber": "0x973182dB27E929e76BB35ff2C08aec6a90BB7614", "currency": "EURT", "transferNetworkId": "TRC20" }, "amount": { "amount": "10.00", "currency": "USDT" }, "reference": "Salary" } } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferPostponedResponse" }, "examples": { "Example": { "id": "300cf317-3b89-45cf-b07a-803e7834815b", "createdAt": "2021-12-31T23:59:59.111Z" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts": { "get": { "tags": [ "Account" ], "summary": "Get all accounts", "description": "Get all accounts", "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Account type: CURRENT/SAVING", "required": false, "deprecated": false }, { "name": "holderId", "in": "query", "schema": { "type": "string" }, "description": "Account holder id", "required": false, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAccountsResponse" }, "examples": { "Example": { "accounts": [ { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "ownerId": "fac781d3-8a6b-4f2c-881f-5f165cffef58", "holderId": "990a8dd2-8458-498b-b3dd-6ebbc2fb7070", "name": "USDT Account", "balance": { "amount": "100.00", "currency": "USDT" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] }, "post": { "tags": [ "Account" ], "summary": "Create a new account", "description": "Create a new account", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "Example": { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "ownerId": "fac781d3-8a6b-4f2c-881f-5f165cffef58", "holderId": "990a8dd2-8458-498b-b3dd-6ebbc2fb7070", "name": "USDT Account", "balance": { "amount": "100.00", "currency": "USDT" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts/{id}": { "get": { "tags": [ "Account" ], "summary": "Get account by id", "description": "Get account by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Account's id", "required": true, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "Example": { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "ownerId": "fac781d3-8a6b-4f2c-881f-5f165cffef58", "holderId": "990a8dd2-8458-498b-b3dd-6ebbc2fb7070", "name": "USDT Account", "balance": { "amount": "100.00", "currency": "USDT" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts/{id}/terminate": { "post": { "tags": [ "Account" ], "summary": "Terminate account by id", "description": "Terminate account by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Account's id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts/{id}/name": { "patch": { "tags": [ "Account" ], "summary": "Update account name by id", "description": "Update account name by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Account's id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdateNameRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" }, "examples": { "Example": { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "ownerId": "fac781d3-8a6b-4f2c-881f-5f165cffef58", "holderId": "990a8dd2-8458-498b-b3dd-6ebbc2fb7070", "name": "USDT Account", "balance": { "amount": "100.00", "currency": "USDT" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts/{id}/addresses": { "get": { "tags": [ "Account" ], "summary": "Get account routing addresses by id", "description": "Get account routing addresses by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Account's id", "required": true, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAccountAddressesResponse" }, "examples": { "Example": { "addresses": [ { "id": "2afdfb6f-ebda-4dfd-a344-fd916df7d978", "type": "INTERNATIONAL", "designation": "UNIVERSAL", "accountNumber": { "type": "IBAN", "value": "CH123450000000000" }, "routingNumber": { "type": "BIC", "value": "RAZZBCHZETD" }, "bankName": "Razz Finanzz AG", "bankAddress": "Kazakhstan, Almaty, Makatayev str, 73", "reference": "ID-IN-POOL", "referenceProvider": "Brighty Digital UAB", "referenceProviderAddress": "Konstitucijos pr. 21, Vilnius, Lithuania, 09306", "supportedNetworks": [ "SWIFT" ] }, { "id": "a3079192-61e0-49f0-81db-165040684729", "type": "ERC20", "designation": "UNIVERSAL", "cryptoAccount": "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/accounts/{id}/addresses/crypto": { "post": { "tags": [ "Account" ], "summary": "Create a crypto account address", "description": "Create a crypto account address", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Account's id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCryptoAccountAddressRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAddress" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/transfers/own": { "post": { "tags": [ "OwnTransfer" ], "summary": "Create a transfer between own accounts", "description": "Create a transfer between own accounts", "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnTransferCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnTransferCreated" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/transfers/own/intent": { "post": { "tags": [ "OwnTransfer" ], "summary": "Calculate a transfer intent", "description": "Calculate a transfer intent", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnTransferIntentRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnTransferIntent" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/members": { "get": { "tags": [ "Members" ], "summary": "List members of the business", "description": "List members of the business", "parameters": [ { "name": "withTerminated", "in": "query", "schema": { "type": "string" }, "description": "Flag to include terminated memberships in listing. False by-default", "required": false, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMembersResponse" }, "examples": { "Example": { "members": [ { "customer": { "id": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "username": "@boss", "name": "Very Important Guy", "picture": "https://gatheron.khd/d0318be5-88b4-4e29-8e03-2647eb6bca19" }, "membership": { "memberId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "role": "OWNER", "state": "ACTIVE" }, "contact": { "email": "boss@business.com", "phone": "+1 999 999 999" }, "legalData": { "name": { "firstName": "Very", "lastName": "Important" }, "address": { "country": "PT", "region": "Lisbon", "city": "Lisbon", "zipCode": "1990-503", "streetLine1": "Passeio do Levante" }, "birthInfo": { "birthDate": "1996-09-20", "birthPlace": { "country": "PT", "city": "Lisbon" } }, "legalSex": "M", "countryOfResidence": "PT", "nationality": "PT" } }, { "customer": { "id": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "username": "@fired", "name": "Fired Guy", "picture": "https://gatheron.khd/d0318be5-88b4-4e29-8e03-2647eb6bca19" }, "membership": { "memberId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "role": "MEMBER", "state": "TERMINATED" }, "contact": { "email": "fired@business.com", "phone": "+1 999 999 999" }, "legalData": { "name": { "firstName": "Fired", "lastName": "Guy" }, "address": { "country": "PT", "region": "Lisbon", "city": "Lisbon", "zipCode": "1990-503", "streetLine1": "Passeio do Levante" }, "birthInfo": { "birthDate": "1996-09-20", "birthPlace": { "country": "PT", "city": "Lisbon" } }, "legalSex": "M", "countryOfResidence": "PT", "nationality": "PT" } } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] }, "post": { "tags": [ "Members" ], "summary": "Add new members of the business", "description": "Add new members of the business", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMembersRequest" }, "examples": { "Example": { "members": [ { "email": "employee@business.com", "role": "MEMBER", "legalName": { "firstName": "Employee", "lastName": "Guy" }, "birthInfo": { "birthDate": "1996-09-20", "birthPlace": { "country": "PT", "city": "Lisboa" } }, "nationality": "PT" }, { "email": "admin@business.com", "role": "ADMIN" } ] } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List-Membership" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/members/remove": { "post": { "tags": [ "Members" ], "summary": "Terminate business memberships", "description": "Terminate business memberships", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveMembersRequest" }, "examples": { "Example": { "members": [ "f0a0fee9-3e31-4bf9-9b41-98ed9adc93c4", "5c2550ad-ae8b-47c4-bcb7-d9ac28ec7958" ] } } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/members/{id}/legalInfo": { "patch": { "tags": [ "Members" ], "summary": "Update members' legal info", "description": "Update members' legal info", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Members' id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMemberLegalInfoRequest" }, "examples": { "Example": { "legalName": { "firstName": "Employee", "lastName": "Guy", "middleName": "John" }, "birthInfo": { "birthDate": "1996-09-20", "birthPlace": { "country": "PT", "city": "Lisboa" } }, "nationality": "PT" } } } }, "required": true }, "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/members/{id}/access": { "post": { "tags": [ "Members" ], "summary": "Issue new access for member", "description": "Issue new access for member", "parameters": [], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueMemberAccessResponse" }, "examples": { "Example": { "access": { "url": "https://ext.brighty.app#memberToken=token123", "validUntil": "2026-02-16T15:36:25.886Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] }, "delete": { "tags": [ "Members" ], "summary": "Deactivate access for member", "description": "Deactivate access for member", "parameters": [], "responses": { "204": { "description": "" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/members/external": { "post": { "tags": [ "Members" ], "summary": "Add new external member", "description": "Add new external member", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExternalMemberRequest" }, "examples": { "Example": { "externalId": "a11a1edf-b43b-4bac-a9c3-a0dd3333327cc" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExternalMemberResponse" }, "examples": { "Example": { "membership": { "memberId": "f8a1e626-78cc-4ed7-bba6-8b47a842dc87", "role": "MEMBER", "state": "ACTIVE" }, "access": { "url": "https://ext.brighty.app#memberToken=token123", "validUntil": "2026-02-16T15:36:25.886Z" }, "account": { "id": "797d325e-f578-4ed7-a4bd-5add35b4af3d", "ownerId": "fac781d3-8a6b-4f2c-881f-5f165cffef58", "holderId": "990a8dd2-8458-498b-b3dd-6ebbc2fb7070", "name": "USDC Account", "balance": { "amount": "100.00", "currency": "USDC" }, "type": "CURRENT", "openedAt": "2026-02-16T23:59:59.111Z" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards": { "get": { "tags": [ "Cards" ], "summary": "List all cards held by business", "description": "List all cards held by business", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCards" }, "examples": { "Example": { "cards": [ { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } }, { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/order/intent": { "post": { "tags": [ "Cards" ], "summary": "Check ability to order card", "description": "Check ability to order card", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardOrderIntentRequest" }, "examples": { "Example": { "customerId": "7e9e39d7-3f12-4226-81ce-b594559311d7", "cardDesignId": "9bf10303-d4e9-444c-822e-74846a6468c6", "holderName": "John Doe" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardOrderIntentResponse" }, "examples": { "Example": { "amount": { "amount": "10.00", "currency": "EUR" }, "fees": { "CARD_ISSUE": { "sourceAmount": { "amount": "4.23", "currency": "EUR" }, "targetAmount": { "amount": "5.00", "currency": "USD" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" } }, "FX": { "sourceAmount": { "amount": "4.23", "currency": "EUR" }, "targetAmount": { "amount": "5.00", "currency": "USD" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" } } }, "remainingLimits": { "TOTAL": 1 }, "hash": "769a7bc101ded1e48024a57ad1ca845a008b05e12654c6235732f73b0fcb83fc", "holderNameValidity": { "type": "VALID", "holderName": "John Doe" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/order": { "post": { "tags": [ "Cards" ], "summary": "Order a new card", "description": "Order a new card", "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": false, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardOrderRequest" }, "examples": { "Example": { "customerId": "413ed22b-3f26-498c-b346-9873e42affdd", "cardDesignId": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "sourceAccountId": "fed4a73b-fefa-4d02-b9e4-40d3f242d1e0", "fees": { "CARD_ISSUE": { "sourceAmount": { "amount": "10.00", "currency": "EUR" }, "targetAmount": { "amount": "10.00", "currency": "EUR" } }, "FX": { "sourceAmount": { "amount": "1.00", "currency": "EUR" }, "targetAmount": { "amount": "1.00", "currency": "EUR" } } }, "holderName": "John Doe", "cardName": "My cool card", "hash": "4b7dcac8ce02718b5265a6771524bea3269e0d37d1f53f6e6cc2836d78f610b0" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardOrderResponse" }, "examples": { "Example": { "card": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "CREATED", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/products/virtual": { "get": { "tags": [ "Cards" ], "summary": "Get product conditions for virtual cards", "description": "Get product conditions for virtual cards", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardProductResponse" }, "examples": { "Example": { "product": { "conditions": [ { "id": "66ff49ba-d8fe-49c5-9f2a-d8fa7eb16cd7", "cardIssuer": "MARQETA", "code": "QWERTY", "cardType": "DEBIT", "formFactor": "VIRTUAL", "totalLimit": 5, "freeLimit": 1, "issueFee": { "amount": "1.00", "currency": "EUR" }, "usage": { "number": 10 } } ] } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/designs": { "get": { "tags": [ "Cards" ], "summary": "Get available card designs", "description": "Get available card designs", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCardDesignsResponse" }, "examples": { "Example": { "cardDesigns": [ { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" } ] } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}": { "get": { "tags": [ "Cards" ], "summary": "Get card by id", "description": "Get card by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/security": { "get": { "tags": [ "Cards" ], "summary": "Get card security policies", "description": "Get card security policies", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityResponse" }, "examples": { "Example": { "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/limits": { "put": { "tags": [ "Cards" ], "summary": "Update card spending limits", "description": "Update card spending limits", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLimitsUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/activate": { "post": { "tags": [ "Cards" ], "summary": "Activate issued card", "description": "Activate issued card", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": false, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/unfreeze": { "post": { "tags": [ "Cards" ], "summary": "Unfreeze card", "description": "Unfreeze card", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": false, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/freeze": { "post": { "tags": [ "Cards" ], "summary": "Freeze card", "description": "Freeze card", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": false, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "FROZEN", "statusReason": "REQUESTED_BY_CUSTOMER", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/rename": { "patch": { "tags": [ "Cards" ], "summary": "Rename card", "description": "Rename card", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardRenameRequest" }, "examples": { "Example": { "name": "Cool card" } } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "ACTIVE", "name": "Cool card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/credentialsUri": { "post": { "tags": [ "Cards" ], "summary": "Get card credentials URI", "description": "Get card credentials URI", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCredentialsUri" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/setPinUri": { "post": { "tags": [ "Cards" ], "summary": "Get card set-PIN URI", "description": "Get card set-PIN URI", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSetPinUri" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/pinUri": { "post": { "tags": [ "Cards" ], "summary": "Get card PIN URI", "description": "Get card PIN URI", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardPinUri" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/cards/{id}/terminate": { "post": { "tags": [ "Cards" ], "summary": "Terminate card", "description": "Terminate card", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Card id", "required": true, "deprecated": false }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" }, "description": "A unique key that can be used to avoid creating duplicate resources", "required": false, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Card" }, "examples": { "Example": { "id": "a92a1edf-b43b-4bac-a9c3-a0dd545527cc", "cardOwnerId": "822089d0-9a90-45fe-98ef-8a6a201ffc81", "cardHolderId": "ac8691a2-1e54-4fc7-9f85-dc8c11c32b72", "status": "TERMINATED", "statusReason": "REQUESTED_BY_CUSTOMER", "name": "My Card", "type": "DEBIT", "network": "MASTERCARD", "formFactor": "VIRTUAL", "lastFour": "1234", "bin": "123456", "expirationDate": "2023-12", "cardHolderName": "Boss Man", "securityPolicy": { "contactless": true, "internet": true, "atm": false, "location": false, "ecommerce": true }, "spendingStrategy": { "name": "SINGLE", "accountId": "731db711-3e9d-4c6c-8283-5ead8723a639", "currency": "EUR" }, "spendingLimit": { "name": "MONTHLY", "setAt": "2025-05-29T15:36:25.886Z", "since": "2025-06-01T00:00:00.000Z", "until": "2025-07-01T00:00:00.000Z", "limit": { "amount": "100.00", "currency": "EUR" }, "spentAmount": { "amount": "50.00", "currency": "EUR" } }, "cardDesign": { "id": "3961d30a-71ec-4330-bbea-2df2fe96af0f", "conditionId": "944624a3-d761-4e41-832d-d3ffad98e3e3", "code": "QWERTY", "formFactor": "VIRTUAL", "cardNetwork": "MASTERCARD", "image": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "previewImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "backgroundImage": "https://gatheron.khd/3961d30a-71ec-4330-bbea-2df2fe96af0f", "status": "AVAILABLE", "backgroundColor": "#d7db58", "foregroundPrimaryColor": "#6847e1", "foregroundSecondaryColor": "#3a7945" }, "createdAt": "2025-05-29T15:36:25.886Z", "issuedAt": "2025-05-29T15:37:12.000Z", "activatedAt": "2025-05-29T16:01:35.000Z", "limitAmount": { "amount": "100.00", "currency": "EUR" }, "availableAmount": { "amount": "50.00", "currency": "EUR" } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/transactions": { "get": { "tags": [ "Transaction" ], "summary": "List all transactions", "description": "List all transactions", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "string" }, "description": "Next page to get (Base-64 value)", "required": false, "deprecated": false }, { "name": "until", "in": "query", "schema": { "type": "string" }, "description": "Upper time-bound timestamp", "required": false, "deprecated": false }, { "name": "since", "in": "query", "schema": { "type": "string" }, "description": "Lower time-bound timestamp", "required": false, "deprecated": false }, { "name": "accountId", "in": "query", "schema": { "type": "string" }, "description": "Id of the account related to transactions", "required": false, "deprecated": false }, { "name": "cardId", "in": "query", "schema": { "type": "string" }, "description": "Id of the card related to transactions", "required": false, "deprecated": false }, { "name": "vaultId", "in": "query", "schema": { "type": "string" }, "description": "Id of the vault related to transactions", "required": false, "deprecated": false }, { "name": "categories", "in": "query", "schema": { "items": { "type": "string" }, "type": "array" }, "description": "Transaction category. Available values: ATM, CARD_PAYMENT, SAVINGS, INTERNAL_TRANSFER, EXTERNAL_TRANSFER, OTHER", "required": false, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransactions" }, "examples": { "Example": { "transactions": [ { "id": "1a98dcb4-22a3-452f-85d5-e4a2f8410764", "type": "CARD_PAYMENT", "direction": "OUT", "state": "COMPLETED", "description": "Card payment at DAD SHOP", "origin": { "type": "CUSTOMER", "amount": { "amount": "100.00", "currency": "EUR" }, "totalFee": { "amount": "5.00", "currency": "EUR" }, "amountWithoutFee": { "amount": "95.00", "currency": "EUR" }, "fees": { "CARD_FX": { "sourceAmount": { "amount": "100.00", "currency": "EUR" }, "targetAmount": { "amount": "98.00", "currency": "USD" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" } } }, "customer": { "id": "cce4712d-6277-4e2c-bea2-434fecec64e5", "username": "@aboba", "name": "A Boba", "picture": "https://image.com/f824f5d0-f7ce-4ab4-8930-dc9ca4651d4a.jpg" }, "account": { "id": "534e1dae-6570-4e0e-abb6-8276d6707540", "ownerId": "426fd2da-fbc8-477e-bc15-5181476a51e0", "holderId": "bc9e2f78-f36b-46f0-8783-db60beec4f19", "name": "EUR Account", "balance": { "amount": "150.00", "currency": "EUR" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" }, "card": { "cardId": "cfeaed82-97eb-4380-a354-31814969824e", "name": "EUR card", "lastFour": "9876" } }, "counterparty": { "type": "MERCHANT", "amount": { "amount": "98.00", "currency": "USD" }, "merchant": { "merchantId": "cbaf7d46-10cc-46a0-9158-a395e30e0bbf", "mcc": "1234", "category": "Shopping", "name": "DAD SHOP", "address": "Istanbul", "logo": "https://image.com/0801b321-6dbc-4d2d-97c7-47bc1b96515f.jpg" }, "mcc": { "code": "1234", "description": "Shopping" } }, "date": { "created": "2021-04-04T04:04:04.590Z", "started": "2021-04-04T04:04:04.590Z", "updated": "2021-04-04T04:04:04.590Z", "settled": "2021-04-04T04:04:04.590Z", "processed": "2021-04-04T04:04:04.590Z" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" }, "category": "CARD_PAYMENT" }, { "id": "4fbf194f-64ee-4e55-b12a-55c759b48bcf", "type": "EXTERNAL_INCOMING_TRANSFER", "direction": "IN", "state": "COMPLETED", "description": "Card payment at DAD SHOP", "origin": { "type": "PAYER", "amount": { "amount": "0.100000", "currency": "USDT" }, "payer": { "payerId": "13683c63-b158-46d5-8c8e-5f1c375f0b7f", "type": "CRYPTO", "network": "ERC20", "accountNumber": "0x72BF0Bf2270cd0Dd377420fa4432dB504De40", "name": "Mr Crypto" } }, "counterparty": { "type": "CUSTOMER", "amount": { "amount": "0.100000", "currency": "USDT" }, "customer": { "id": "5b0f41e1-c240-4907-b72e-ae727dcf109e", "username": "@aboba", "name": "A Boba", "picture": "https://image.com/b21e2acc-b001-4041-b8ff-b8132994770b.jpg" }, "account": { "id": "0bbb63aa-8068-499b-8087-665bcf8ff1bc", "ownerId": "a44fdddf-7433-4b91-80f1-5c1919986423", "holderId": "756a8380-2543-45b9-9677-a461e981e037", "name": "USDT Account", "balance": { "amount": "2.000000", "currency": "EUR" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" }, "crypto": { "transactionHash": "0xdcd0040107e206d4a9c1f84fef0149627cfc4e370ef1159a3c3b8022ee8fb91a", "link": "https://etherscan.io/tx/0xdcd0040107e206d4a9c1f84fef0149627cfc4e370ef1159a3c3b8022ee8fb91a" } }, "date": { "created": "2021-04-04T04:04:04.590Z", "started": "2021-04-04T04:04:04.590Z", "updated": "2021-04-04T04:04:04.590Z", "settled": "2021-04-04T04:04:04.590Z", "processed": "2021-04-04T04:04:04.590Z" }, "category": "EXTERNAL_TRANSFER" } ], "nextPage": "OGJmNGIzM2QtNDc0Mi00NWExLWI0YjMtM2Q0NzQyZjVhMTRl" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/transactions/summary": { "get": { "tags": [ "Transaction" ], "summary": "Get transactions summary", "description": "Get transactions summary", "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string" }, "description": "Id of the account related to transactions", "required": false, "deprecated": false }, { "name": "cardId", "in": "query", "schema": { "type": "string" }, "description": "Id of the card related to transactions", "required": false, "deprecated": false }, { "name": "vaultId", "in": "query", "schema": { "type": "string" }, "description": "Id of the vault related to transactions", "required": false, "deprecated": false }, { "name": "currency", "in": "query", "schema": { "type": "string" }, "description": "Currency code of related transactions", "required": false, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionSummary" }, "examples": { "Example": { "amountSpent": { "amount": "370.00", "currency": "USD" }, "byCategory": { "CARD_PAYMENT": { "amount": "270.00", "currency": "USD" }, "OTHER": { "amount": "100.00", "currency": "USD" } } } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/transactions/{id}": { "get": { "tags": [ "Transaction" ], "summary": "Get transaction by id", "description": "Get transaction by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Transaction id", "required": true, "deprecated": false }, { "name": "createdAt", "in": "query", "schema": { "type": "string" }, "description": "Transaction creation timestamp. Used for internal partitioning (now ± 2 days by-default)", "required": false, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" }, "examples": { "Example": { "id": "1a98dcb4-22a3-452f-85d5-e4a2f8410764", "type": "CARD_PAYMENT", "direction": "OUT", "state": "COMPLETED", "description": "Card payment at DAD SHOP", "origin": { "type": "CUSTOMER", "amount": { "amount": "100.00", "currency": "EUR" }, "totalFee": { "amount": "5.00", "currency": "EUR" }, "amountWithoutFee": { "amount": "95.00", "currency": "EUR" }, "fees": { "CARD_FX": { "sourceAmount": { "amount": "100.00", "currency": "EUR" }, "targetAmount": { "amount": "98.00", "currency": "USD" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" } } }, "customer": { "id": "cce4712d-6277-4e2c-bea2-434fecec64e5", "username": "@aboba", "name": "A Boba", "picture": "https://image.com/f824f5d0-f7ce-4ab4-8930-dc9ca4651d4a.jpg" }, "account": { "id": "534e1dae-6570-4e0e-abb6-8276d6707540", "ownerId": "426fd2da-fbc8-477e-bc15-5181476a51e0", "holderId": "bc9e2f78-f36b-46f0-8783-db60beec4f19", "name": "EUR Account", "balance": { "amount": "150.00", "currency": "EUR" }, "type": "CURRENT", "openedAt": "2021-12-31T23:59:59.111Z" }, "card": { "cardId": "cfeaed82-97eb-4380-a354-31814969824e", "name": "EUR card", "lastFour": "9876" } }, "counterparty": { "type": "MERCHANT", "amount": { "amount": "98.00", "currency": "USD" }, "merchant": { "merchantId": "cbaf7d46-10cc-46a0-9158-a395e30e0bbf", "mcc": "1234", "category": "Shopping", "name": "DAD SHOP", "address": "Istanbul", "logo": "https://image.com/0801b321-6dbc-4d2d-97c7-47bc1b96515f.jpg" }, "mcc": { "code": "1234", "description": "Shopping" } }, "date": { "created": "2021-04-04T04:04:04.590Z", "started": "2021-04-04T04:04:04.590Z", "updated": "2021-04-04T04:04:04.590Z", "settled": "2021-04-04T04:04:04.590Z", "processed": "2021-04-04T04:04:04.590Z" }, "fx": { "rate": { "currencyPair": { "base": "USD", "counter": "EUR" }, "timestamp": "2023-01-01T00:00:00.000Z", "bid": "0.831", "ask": "0.832" }, "side": "BUY", "appliedMarkup": "0", "feeMarkup": "0", "availability": "TRADABLE" }, "category": "CARD_PAYMENT" } } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/threeDS": { "get": { "tags": [ "3DS" ], "summary": "List all pending 3DS requests", "description": "List all pending 3DS requests", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListThreeDS" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/threeDS/{id}": { "get": { "tags": [ "3DS" ], "summary": "Get 3DS by id", "description": "Get 3DS by id", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "3DS id", "required": true, "deprecated": false } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDS" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/threeDS/{id}/approve": { "post": { "tags": [ "3DS" ], "summary": "Approve 3DS", "description": "Approve 3DS", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "3DS id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDS" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/threeDS/{id}/decline": { "post": { "tags": [ "3DS" ], "summary": "Decline 3DS", "description": "Decline 3DS", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "3DS id", "required": true, "deprecated": false } ], "requestBody": { "description": "", "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDS" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } }, "/business/v1/onramp": { "post": { "tags": [ "Onramp" ], "summary": "Create a crypto onramp widget URL", "description": ":::warning\nThis feature is available only upon agreement. Please contact your account manager to enable it.\n:::\n\nCreate a crypto onramp widget URL", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnrampRequest" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnrampResponse" } } } }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "deprecated": false, "security": [ { "Bearer Authorization": [] } ] } } }, "components": { "schemas": { "Instant": { "type": "string", "format": "Instant" }, "URI": { "type": "string", "format": "URI" }, "LocalDate": { "type": "string", "format": "LocalDate" }, "YearMonth": { "type": "string", "format": "YearMonth" }, "BigInteger": { "type": "number", "format": "BigInteger" }, "BigDecimal": { "type": "number", "format": "BigDecimal" }, "Currency": { "type": "string", "format": "Currency" }, "GetPayoutsResponse": { "type": "object", "properties": { "nextPage": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "A base64 hash to get a next page of payouts" }, "payouts": { "items": { "$ref": "#/components/schemas/PubApiPayoutPayout" }, "deprecated": false, "description": "List of payouts", "maxItems": 30, "minItems": 0, "type": "array" } }, "required": [ "payouts" ] }, "PubApiPayoutPayout": { "type": "object", "properties": { "completedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the payout was completed (All transfers were paid or failed). Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z", "maxLength": 2147483647, "minLength": 0 } ] }, "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the payout was created. Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z", "maxLength": 2147483647, "minLength": 0 }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The description of the payout. Example: 'Monthly payroll'" }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the payout. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The name of the payout. Example: 'Payroll'" }, "paidAmount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "A total amount of all transfers that were paid in your base currency." } ] }, "paidTransfers": { "type": "number", "format": "int32", "deprecated": false, "description": "The number of transfers that were paid. Example: 100", "maximum": 2147483647, "minimum": -2147483648 }, "startedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the payout was started. Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z", "maxLength": 2147483647, "minLength": 0 } ] }, "state": { "$ref": "#/components/schemas/PubApiPayoutPayoutState", "deprecated": false, "description": "The state of the payout. Possible values: CREATED, STARTED, COMPLETED" }, "totalAmount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "A total amount of all transfers in your base currency." } ] }, "totalTransfers": { "type": "number", "format": "int32", "deprecated": false, "description": "The total number of transfers in the payout. Example: 100", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "createdAt", "id", "paidTransfers", "state", "totalTransfers" ] }, "Money": { "type": "object", "properties": { "amount": { "type": "string", "deprecated": false, "description": "The amount of money. Example: 1000.12", "maxLength": 2147483647, "minLength": 1 }, "currency": { "type": "string", "deprecated": false, "description": "The currency of the money. Example: 'USD'", "maxLength": 10, "minLength": 1 } }, "required": [ "amount", "currency" ] }, "PubApiPayoutPayoutState": { "type": "string", "enum": [ "CREATED", "STARTED", "COMPLETED", "CANCELED", "PAUSED" ] }, "PayoutCreateRequest": { "type": "object", "properties": { "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The description of the payout. Example: 'Monthly payroll'" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The name of the payout. Example: 'Payroll'" } }, "required": [] }, "GetPayoutResponse": { "type": "object", "properties": { "payout": { "$ref": "#/components/schemas/PubApiPayoutPayout", "deprecated": false, "description": "Payout object" }, "transfers": { "items": { "anyOf": [ { "$ref": "#/components/schemas/CryptoTransfer" }, { "$ref": "#/components/schemas/FiatTransfer" }, { "$ref": "#/components/schemas/InternalTransfer" } ] }, "deprecated": false, "description": "List of transfers", "maxItems": 30, "minItems": 0, "type": "array" } }, "required": [ "payout", "transfers" ] }, "CryptoTransfer": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer" }, "amountWithFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer including fees" }, "completedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was completed. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 } ] }, "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was created. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 }, "fromAccount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FromAccount", "deprecated": false, "description": "Account to withdraw from" } ] }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the transfer. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 }, "reference": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The description of the transfer" }, "status": { "$ref": "#/components/schemas/TransferStatus", "deprecated": false, "description": "The status of the transfer. Example: COMPLETED" }, "toAccount": { "$ref": "#/components/schemas/CryptoTransferAccount", "deprecated": false, "description": "Account to deposit" }, "totalFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The total fee of the transfer" }, "type": { "enum": [ "Crypto" ] } }, "required": [ "amount", "amountWithFee", "createdAt", "id", "status", "toAccount", "totalFee", "type" ] }, "FromAccount": { "type": "object", "properties": { "balance": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The available balance of your account" }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of your account. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 }, "name": { "type": "string", "deprecated": false, "description": "The name of your account. Example: 'USDT account'", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "balance", "id", "name" ] }, "TransferStatus": { "type": "string", "enum": [ "POSTPONED", "PENDING", "SUSPENDED", "COMPLETED", "FAILED" ] }, "CryptoTransferAccount": { "type": "object", "properties": { "address": { "type": "string", "deprecated": false, "description": "Crypto address. Example: 1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71 (Bitcoin network)", "maxLength": 100, "minLength": 0 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the account. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 2147483647, "minLength": 0 }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The name of the beneficiary. Example: John Doe" }, "network": { "$ref": "#/components/schemas/CryptoTransferNetworkId", "deprecated": false, "description": "The network of the crypto. Example: ERC20 or TRC20" } }, "required": [ "address", "id", "network" ] }, "CryptoTransferNetworkId": { "type": "string", "enum": [ "ERC20", "TRC20", "BEP20", "POLYGON", "ARBITRUM", "BASE", "CARDANO", "TEZOS", "BTC_LEGACY", "BTC_SEGWIT", "HAQQ", "SOLANA", "TON" ] }, "FiatTransfer": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer" }, "amountWithFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer including fees" }, "completedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was completed. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 } ] }, "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was created. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 }, "fromAccount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FromAccount", "deprecated": false, "description": "Account to withdraw from" } ] }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the transfer. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 }, "reference": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The reference of the transfer" }, "status": { "$ref": "#/components/schemas/TransferStatus", "deprecated": false, "description": "The status of the transfer. Example: COMPLETED" }, "toAccount": { "$ref": "#/components/schemas/FiatTransferAccount", "deprecated": false, "description": "Account to deposit" }, "totalFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The total fee of the transfer" }, "type": { "enum": [ "Fiat" ] } }, "required": [ "amount", "amountWithFee", "createdAt", "id", "status", "toAccount", "totalFee", "type" ] }, "FiatTransferAccount": { "type": "object", "properties": { "accountNumber": { "type": "string", "deprecated": false, "description": "The account number. Example: PT50000201231234567890154", "maxLength": 100, "minLength": 0 }, "beneficiaryName": { "type": "string", "deprecated": false, "description": "The name of the beneficiary. Example: John Doe", "maxLength": 2147483647, "minLength": 0 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the account. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 2147483647, "minLength": 0 }, "routingNumber": { "type": "string", "deprecated": false, "description": "The routing number. Example: 123456789", "maxLength": 9, "minLength": 0 } }, "required": [ "accountNumber", "beneficiaryName", "id", "routingNumber" ] }, "InternalTransfer": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer" }, "amountWithFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount of the transfer including fees" }, "completedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was completed. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 } ] }, "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was created. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 }, "fromAccount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FromAccount", "deprecated": false, "description": "Account to withdraw from" } ] }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the transfer. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 }, "reference": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The description of the transfer" }, "status": { "$ref": "#/components/schemas/TransferStatus", "deprecated": false, "description": "The status of the transfer. Example: COMPLETED" }, "toAccount": { "$ref": "#/components/schemas/BrightyTransferAccount", "deprecated": false, "description": "Account to deposit" }, "totalFee": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The total fee of the transfer" }, "type": { "enum": [ "Internal" ] } }, "required": [ "amount", "amountWithFee", "createdAt", "id", "status", "toAccount", "totalFee", "type" ] }, "BrightyTransferAccount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the Brighty customer. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 2147483647, "minLength": 0 }, "name": { "type": "string", "deprecated": false, "description": "The name of the Brighty customer. Example: John Doe", "maxLength": 2147483647, "minLength": 0 }, "picture": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "URI" } ] }, "username": { "type": "string", "deprecated": false, "description": "The username of the Brighty customer. Example: john_doe", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "id", "name", "username" ] }, "PayoutUpdateRequest": { "type": "object", "properties": { "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The description of the payout. Example: 'Monthly payroll'" }, "name": { "type": "string", "deprecated": false, "description": "The name of the payout. Example: 'Payroll'", "maxLength": 300, "minLength": 0 } }, "required": [ "name" ] }, "TransferPostponedResponse": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the transfer was created. Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z", "maxLength": 2147483647, "minLength": 0 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of the transfer. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 } }, "required": [ "createdAt", "id" ] }, "TransferCreateRequest": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount to transfer" }, "comment": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The comment for the transfer. Example: 'Salary payment'" }, "receiverUsername": { "type": "string", "deprecated": false, "description": "Customer's username, who should receive funds", "maxLength": 100, "minLength": 3 }, "sourceAccountId": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of account to withdraw the amount. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 } }, "required": [ "amount", "receiverUsername", "sourceAccountId" ] }, "ExternalTransferCreateRequest": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "The amount to transfer" }, "beneficiary": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Beneficiary", "deprecated": false, "description": "The beneficiary object. You should provide beneficiaryId or either beneficiary object." } ] }, "beneficiaryId": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ], "deprecated": false, "description": "The unique identifier of beneficiary to deposit the amount. You should provide beneficiaryId or either beneficiary object. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000" }, "evidence": { "oneOf": [ { "type": "null" }, { "items": { "type": "string", "format": "URI" }, "type": "array" } ], "deprecated": false, "description": "Paths of the supporting documents" }, "reference": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "The reference for transfer" }, "sourceAccountId": { "type": "string", "format": "uuid", "deprecated": false, "description": "The unique identifier of account to withdraw the amount. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000", "maxLength": 36, "minLength": 36 } }, "required": [ "amount", "sourceAccountId" ] }, "Beneficiary": { "type": "object", "properties": { "accountNumber": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "bankAddress": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "bankCountry": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "bankName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "beneficiaryAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Address" } ] }, "beneficiaryId": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ] }, "beneficiaryName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "businessName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "country": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "destinationTag": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "displayName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "individualName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "routingNumber": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "routingNumber2": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "subtype": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "transferNetworkId": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "type": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [] }, "Address": { "type": "object", "properties": { "city": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "City" }, "country": { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Alpha-2 code. Example: 'US'" }, "region": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Region/district" }, "streetLine1": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Street line 1" }, "streetLine2": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Street line 2" }, "zipCode": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Zip Code" } }, "required": [ "country" ] }, "CountryCode": { "type": "string", "enum": [ "UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW" ] }, "ListAccountsResponse": { "type": "object", "properties": { "accounts": { "items": { "$ref": "#/components/schemas/Account" }, "type": "array" } }, "required": [ "accounts" ] }, "Account": { "type": "object", "properties": { "balance": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Account's balance" }, "holderId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Account holder id. For business-only accounts equal to ownerId, for member accounts equal to memberId", "maxLength": 2147483647, "minLength": 0 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Account's id", "maxLength": 2147483647, "minLength": 0 }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Account's name" }, "openedAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "The date and time when the account was opened. Example: 2021-07-01T12:00:00.000Z", "maxLength": 2147483647, "minLength": 0 }, "ownerId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Account owner id", "maxLength": 2147483647, "minLength": 0 }, "type": { "$ref": "#/components/schemas/CustomerAccountType", "deprecated": false, "description": "Account's type" } }, "required": [ "balance", "holderId", "id", "openedAt", "ownerId", "type" ] }, "CustomerAccountType": { "type": "string", "enum": [ "CURRENT", "SAVING" ] }, "AccountCreateRequest": { "type": "object", "properties": { "currency": { "type": "string", "format": "Currency", "deprecated": false, "description": "Currency code", "maxLength": 2147483647, "minLength": 0 }, "holderId": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ], "deprecated": false, "description": "Member id to hold account (Business id by-default for non-personal accounts)" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Account name" }, "type": { "$ref": "#/components/schemas/CustomerAccountType", "deprecated": false, "description": "Account type" } }, "required": [ "currency", "type" ] }, "AccountUpdateNameRequest": { "type": "object", "properties": { "name": { "type": "string", "deprecated": false, "description": "New account name", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "name" ] }, "ListAccountAddressesResponse": { "type": "object", "properties": { "addresses": { "items": { "$ref": "#/components/schemas/AccountAddress" }, "type": "array" } }, "required": [ "addresses" ] }, "AccountAddress": { "type": "object", "properties": { "accountNumber": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FiatRouting", "deprecated": false, "description": "Account number of FIAT address" } ] }, "bankAddress": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Bank address of FIAT address" }, "bankName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Bank name of FIAT address" }, "cryptoAccount": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Account number of CRYPTO address" }, "designation": { "type": "string", "deprecated": false, "description": "Account address's designation. Possible values: UNIVERSAL, SALARY, PERSONAL, VOID", "maxLength": 2147483647, "minLength": 0 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Account address's id", "maxLength": 2147483647, "minLength": 0 }, "reference": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Reference of FIAT address" }, "referenceProvider": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Name of the reference provider of FIAT address" }, "referenceProviderAddress": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Address of the reference provider of FIAT address" }, "routingNumber": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FiatRouting", "deprecated": false, "description": "Routing number of FIAT address" } ] }, "supportedNetworks": { "oneOf": [ { "type": "null" }, { "items": { "type": "string" }, "type": "array" } ], "deprecated": false, "description": "Supported networks of FIAT address. E.g. SEPA, SEPA_INSTANT, SWIFT, FASTER_PAYMENTS, CHAPS" }, "type": { "type": "string", "deprecated": false, "description": "Transfer Area type. Possible fiat values: INTERNATIONAL, LOCAL_EU, LOCAL_UK, LOCAL_US. For crypto address contains network type (e.g. ERC20 or TON)", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "designation", "id", "type" ] }, "FiatRouting": { "type": "object", "properties": { "type": { "type": "string", "deprecated": false, "description": "AccountAddress (e.g. IBAN) or RoutingNumber (e.g. BIC) type", "maxLength": 2147483647, "minLength": 0 }, "value": { "type": "string", "deprecated": false, "description": "Routing value", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "type", "value" ] }, "CreateCryptoAccountAddressRequest": { "type": "object", "properties": { "type": { "type": "string", "deprecated": false, "description": "Crypto transfer network type (e.g. ERC20, TRC20)", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "type" ] }, "OwnTransferCreated": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "Instant" }, "transactionId": { "type": "string", "format": "uuid" }, "transactionState": { "type": "string" } }, "required": [ "createdAt", "transactionId", "transactionState" ] }, "OwnTransferCreateRequest": { "type": "object", "properties": { "fees": { "items": { "$ref": "#/components/schemas/Fee" }, "type": "array" }, "hash": { "type": "string" }, "quote": { "$ref": "#/components/schemas/Quote" }, "sourceAccountId": { "type": "string", "format": "uuid" }, "targetAccountId": { "type": "string", "format": "uuid" } }, "required": [ "hash", "quote", "sourceAccountId", "targetAccountId" ] }, "Fee": { "type": "object", "properties": { "quote": { "$ref": "#/components/schemas/Quote" }, "type": { "$ref": "#/components/schemas/FeeType" } }, "required": [ "quote", "type" ] }, "Quote": { "type": "object", "properties": { "fx": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Fx" } ] }, "sourceAmount": { "$ref": "#/components/schemas/Money" }, "targetAmount": { "$ref": "#/components/schemas/Money" } }, "required": [ "sourceAmount", "targetAmount" ] }, "Fx": { "type": "object", "properties": { "appliedMarkup": { "type": "number", "format": "BigDecimal" }, "availability": { "$ref": "#/components/schemas/Availability" }, "feeMarkup": { "type": "number", "format": "BigDecimal" }, "rate": { "$ref": "#/components/schemas/Rate" }, "side": { "$ref": "#/components/schemas/Side" } }, "required": [ "rate", "side" ] }, "Availability": { "type": "string", "enum": [ "SUSPENDED", "STALE", "TRADABLE" ] }, "Rate": { "type": "object", "properties": { "ask": { "type": "number", "format": "BigDecimal" }, "bid": { "type": "number", "format": "BigDecimal" }, "currencyPair": { "$ref": "#/components/schemas/CurrencyPair" }, "timestamp": { "type": "string", "format": "Instant" } }, "required": [ "ask", "bid", "currencyPair", "timestamp" ] }, "CurrencyPair": { "type": "object", "properties": { "base": { "type": "string", "format": "Currency" }, "counter": { "type": "string", "format": "Currency" } }, "required": [ "base", "counter" ] }, "Side": { "type": "string", "enum": [ "SELL", "BUY" ] }, "FeeType": { "type": "string", "enum": [ "FX", "SURCHARGE", "ATM", "TRANSFER", "SUBSCRIPTION", "CARD_ISSUE", "CARD_DELIVERY", "CARD_MONTHLY_SERVICE", "CARD_FX", "CARD_PAYMENT_OTHER", "CLOSURE", "DORMANCY", "MARKUP" ] }, "OwnTransferIntent": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "deliveryInfo": { "$ref": "#/components/schemas/DeliveryInfo" }, "fees": { "items": { "$ref": "#/components/schemas/Fee" }, "type": "array" }, "hash": { "type": "string" }, "quote": { "$ref": "#/components/schemas/Quote" } }, "required": [ "amount", "deliveryInfo", "fees", "hash", "quote" ] }, "DeliveryInfo": { "type": "object", "properties": { "estimatedDeliveryDate": { "type": "string", "format": "Instant" } }, "required": [ "estimatedDeliveryDate" ] }, "OwnTransferIntentRequest": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "side": { "$ref": "#/components/schemas/Side" }, "sourceCurrency": { "type": "string" }, "targetCurrency": { "type": "string" } }, "required": [ "amount", "side", "sourceCurrency", "targetCurrency" ] }, "ListMembersResponse": { "type": "object", "properties": { "members": { "items": { "$ref": "#/components/schemas/Member" }, "type": "array" } }, "required": [ "members" ] }, "Member": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/MemberContactInfo", "deprecated": false, "description": "Member contact info" }, "customer": { "$ref": "#/components/schemas/CustomerProfile", "deprecated": false, "description": "Member customer info" }, "legalData": { "$ref": "#/components/schemas/MemberLegalData", "deprecated": false, "description": "Member legal data" }, "membership": { "$ref": "#/components/schemas/Membership", "deprecated": false, "description": "Membership info" } }, "required": [ "contact", "customer", "legalData", "membership" ] }, "MemberContactInfo": { "type": "object", "properties": { "email": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Member email" }, "phone": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Member phone" } }, "required": [] }, "CustomerProfile": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer id", "maxLength": 2147483647, "minLength": 0 }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Customer name" }, "picture": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "URI", "deprecated": false, "description": "Customer avatar url", "maxLength": 2147483647, "minLength": 0 } ] }, "username": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Customer username" } }, "required": [ "id" ] }, "MemberLegalData": { "type": "object", "properties": { "address": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Address", "deprecated": false, "description": "Member legal address" } ] }, "birthInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BirthInfo", "deprecated": false, "description": "Member birth info" } ] }, "countryOfResidence": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Country of member legal residence alpha-2 code. Example 'US'" } ] }, "legalSex": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Member legal sex, [M/F]" }, "name": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Name", "deprecated": false, "description": "Member legal name" } ] }, "nationality": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Country of member nationality alpha-2 code. Example 'US'" } ] } }, "required": [] }, "BirthInfo": { "type": "object", "properties": { "birthDate": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "LocalDate", "deprecated": false, "description": "Date of birth in format 'yyyy-MM-dd'. Example: '1980-12-31'", "maxLength": 2147483647, "minLength": 0 } ] }, "birthPlace": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BirthPlace", "deprecated": false, "description": "Place of birth" } ] } }, "required": [] }, "BirthPlace": { "type": "object", "properties": { "city": { "type": "string", "deprecated": false, "description": "City of birth", "maxLength": 2147483647, "minLength": 0 }, "country": { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Country of birth alpha-2 code. Example: 'US'" } }, "required": [ "city", "country" ] }, "Name": { "type": "object", "properties": { "firstName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "First name" }, "lastName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Last name" }, "middleName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Middle name" } }, "required": [] }, "Membership": { "type": "object", "properties": { "memberId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer id of member", "maxLength": 2147483647, "minLength": 0 }, "role": { "$ref": "#/components/schemas/MembershipRole", "deprecated": false, "description": "Membership type" }, "state": { "$ref": "#/components/schemas/MembershipState", "deprecated": false, "description": "Membership status" } }, "required": [ "memberId", "role", "state" ] }, "MembershipRole": { "type": "string", "enum": [ "MEMBER", "VIEWER", "PAYER", "ADMIN", "OWNER" ] }, "MembershipState": { "type": "string", "enum": [ "ACTIVE", "TERMINATED" ] }, "List-Membership": { "items": { "$ref": "#/components/schemas/Membership" }, "type": "array" }, "AddMembersRequest": { "type": "object", "properties": { "members": { "items": { "$ref": "#/components/schemas/MemberData" }, "type": "array" } }, "required": [ "members" ] }, "MemberData": { "type": "object", "properties": { "birthInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BirthInfo", "deprecated": false, "description": "Member birth info. Required if you wish to order card for this member" } ] }, "email": { "type": "string", "deprecated": false, "description": "Member email", "maxLength": 2147483647, "minLength": 0 }, "legalName": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FullName", "deprecated": false, "description": "Member legal name. Required if you wish to order card for this member" } ] }, "nationality": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Member nationality. Alpha-2 code. Required if you wish to order card for this member" } ] }, "role": { "$ref": "#/components/schemas/MembershipRole", "deprecated": false, "description": "Member role" } }, "required": [ "email", "role" ] }, "FullName": { "type": "object", "properties": { "firstName": { "type": "string", "deprecated": false, "description": "First name", "maxLength": 2147483647, "minLength": 0 }, "lastName": { "type": "string", "deprecated": false, "description": "Last name", "maxLength": 2147483647, "minLength": 0 }, "middleName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Middle name" } }, "required": [ "firstName", "lastName" ] }, "RemoveMembersRequest": { "type": "object", "properties": { "members": { "items": { "$ref": "#/components/schemas/CustomersId" }, "deprecated": false, "description": "Customer ids of members to remove", "type": "array" } }, "required": [ "members" ] }, "CustomersId": { "type": "object", "properties": { "type": "string", "format": "uuid" }, "required": [ "value" ] }, "UpdateMemberLegalInfoRequest": { "type": "object", "properties": { "birthInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BirthInfo", "deprecated": false, "description": "Member birth info. Required if you wish to order card for this member" } ] }, "legalName": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FullName", "deprecated": false, "description": "Member legal name. Required if you wish to order card for this member" } ] }, "nationality": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CountryCode", "deprecated": false, "description": "Member nationality. Alpha-2 code. Required if you wish to order card for this member" } ] } }, "required": [] }, "IssueMemberAccessResponse": { "type": "object", "properties": { "access": { "$ref": "#/components/schemas/MembershipAccess", "deprecated": false, "description": "Membership access" } }, "required": [ "access" ] }, "MembershipAccess": { "type": "object", "properties": { "url": { "type": "string", "format": "URI", "deprecated": false, "description": "Access URL", "maxLength": 2147483647, "minLength": 0 }, "validUntil": { "type": "string", "format": "Instant", "deprecated": false, "description": "Timestamp when the access URL expires", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "url", "validUntil" ] }, "AddExternalMemberResponse": { "type": "object", "properties": { "access": { "$ref": "#/components/schemas/MembershipAccess", "deprecated": false, "description": "Membership access" }, "account": { "$ref": "#/components/schemas/Account", "deprecated": false, "description": "Account" }, "membership": { "$ref": "#/components/schemas/Membership", "deprecated": false, "description": "Membership" } }, "required": [ "access", "account", "membership" ] }, "AddExternalMemberRequest": { "type": "object", "properties": { "externalId": { "type": "string", "deprecated": false, "description": "Unique external ID. Max length is 100, can only contain letters, digits, '_', '-'", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "externalId" ] }, "ListCards": { "type": "object", "properties": { "cards": { "items": { "$ref": "#/components/schemas/Card" }, "deprecated": false, "description": "List of cards", "type": "array" } }, "required": [ "cards" ] }, "Card": { "type": "object", "properties": { "activatedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "Card activation timestamp", "maxLength": 2147483647, "minLength": 0 } ] }, "availableAmount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Card available spending amount" } ] }, "bin": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Card Bank Identification Number" }, "cardDesign": { "$ref": "#/components/schemas/CardDesign", "deprecated": false, "description": "Card design info" }, "cardHolderId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer id of the card holder (Customer representing business member)", "maxLength": 2147483647, "minLength": 0 }, "cardHolderName": { "type": "string", "deprecated": false, "description": "Card holder name", "maxLength": 2147483647, "minLength": 0 }, "cardOwnerId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer id of the card owner (Customer representing business). Always same for cards issued under one business", "maxLength": 2147483647, "minLength": 0 }, "createdAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "Card creation timestamp", "maxLength": 2147483647, "minLength": 0 }, "expirationDate": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "YearMonth", "deprecated": false, "description": "Card expiration date (MM/YY)", "maxLength": 2147483647, "minLength": 0 } ] }, "formFactor": { "$ref": "#/components/schemas/FormFactor", "deprecated": false, "description": "Card form factor" }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Card identifier", "maxLength": 2147483647, "minLength": 0 }, "issuedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "Card issue timestamp", "maxLength": 2147483647, "minLength": 0 } ] }, "lastFour": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Last 4 digits of card number" }, "limitAmount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Monthly spending limit" } ] }, "name": { "type": "string", "deprecated": false, "description": "Card name", "maxLength": 2147483647, "minLength": 0 }, "network": { "$ref": "#/components/schemas/CardNetwork", "deprecated": false, "description": "Card network" }, "securityPolicy": { "$ref": "#/components/schemas/SecurityPolicy", "deprecated": false, "description": "Card security policy" }, "spendingLimit": { "$ref": "#/components/schemas/SpendingLimit", "deprecated": false, "description": "Card spending limits" }, "spendingStrategy": { "$ref": "#/components/schemas/SpendingStrategy", "deprecated": false, "description": "Card spending strategy" }, "status": { "$ref": "#/components/schemas/CardState", "deprecated": false, "description": "Card status" }, "statusReason": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Explanation of card status" }, "type": { "$ref": "#/components/schemas/CardType", "deprecated": false, "description": "Card type" } }, "required": [ "cardDesign", "cardHolderId", "cardHolderName", "cardOwnerId", "createdAt", "formFactor", "id", "name", "network", "securityPolicy", "spendingLimit", "spendingStrategy", "status", "type" ] }, "CardDesign": { "type": "object", "properties": { "backgroundColor": { "type": "string", "deprecated": false, "description": "Card background color (HEX)", "maxLength": 2147483647, "minLength": 0 }, "backgroundImage": { "type": "string", "format": "URI", "deprecated": false, "description": "Card display image background uri", "maxLength": 2147483647, "minLength": 0 }, "cardNetwork": { "$ref": "#/components/schemas/CardNetwork", "deprecated": false, "description": "Card network" }, "code": { "type": "string", "deprecated": false, "description": "", "maxLength": 2147483647, "minLength": 0 }, "conditionId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Card design condition identifier", "maxLength": 2147483647, "minLength": 0 }, "foregroundPrimaryColor": { "type": "string", "deprecated": false, "description": "Card foreground primary color (HEX)", "maxLength": 2147483647, "minLength": 0 }, "foregroundSecondaryColor": { "type": "string", "deprecated": false, "description": "Card foreground secondary color (HEX)", "maxLength": 2147483647, "minLength": 0 }, "formFactor": { "$ref": "#/components/schemas/FormFactor", "deprecated": false, "description": "Card form factor" }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Card design identifier", "maxLength": 2147483647, "minLength": 0 }, "image": { "type": "string", "format": "URI", "deprecated": false, "description": "Card display image uri", "maxLength": 2147483647, "minLength": 0 }, "previewImage": { "type": "string", "format": "URI", "deprecated": false, "description": "Card display image preview uri", "maxLength": 2147483647, "minLength": 0 }, "status": { "$ref": "#/components/schemas/CardDesignStatus", "deprecated": false, "description": "Card design status" } }, "required": [ "backgroundColor", "backgroundImage", "cardNetwork", "code", "conditionId", "foregroundPrimaryColor", "foregroundSecondaryColor", "formFactor", "id", "image", "previewImage", "status" ] }, "CardNetwork": { "type": "string", "enum": [ "VISA", "MASTERCARD" ] }, "FormFactor": { "type": "string", "enum": [ "VIRTUAL", "PLASTIC", "METAL" ] }, "CardDesignStatus": { "type": "string", "enum": [ "AVAILABLE", "DISABLED" ] }, "SecurityPolicy": { "type": "object", "properties": { "atm": { "type": "boolean", "deprecated": false, "description": "Whether ATM withdrawals are enabled", "maxLength": 2147483647, "minLength": 0 }, "contactless": { "type": "boolean", "deprecated": false, "description": "Whether contactless payments are enabled", "maxLength": 2147483647, "minLength": 0 }, "ecommerce": { "type": "boolean", "deprecated": false, "description": "Whether ecommerce payments are enabled", "maxLength": 2147483647, "minLength": 0 }, "internet": { "type": "boolean", "deprecated": false, "description": "Whether internet payments are enabled", "maxLength": 2147483647, "minLength": 0 }, "location": { "type": "boolean", "deprecated": false, "description": "Whether location-based security is enabled", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "atm", "contactless", "internet", "location" ] }, "SpendingLimit": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Limit amount" } ] }, "name": { "$ref": "#/components/schemas/Name", "deprecated": false, "description": "Type of spending limit" }, "setAt": { "type": "string", "format": "Instant", "deprecated": false, "description": "Timestamp of limit application", "maxLength": 2147483647, "minLength": 0 }, "since": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "Timestamp of limit start", "maxLength": 2147483647, "minLength": 0 } ] }, "spentAmount": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Spent amount during current period" } ] }, "until": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant", "deprecated": false, "description": "Timestamp of limit expiration", "maxLength": 2147483647, "minLength": 0 } ] } }, "required": [ "name", "setAt" ] }, "SpendingStrategy": { "type": "object", "properties": { "accountId": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ] }, "currency": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Currency" } ] }, "name": { "$ref": "#/components/schemas/Name" } }, "required": [ "name" ] }, "CardState": { "type": "string", "enum": [ "ISSUED", "CREATED", "ACTIVE", "ACTIVATING", "FROZEN", "TERMINATED" ] }, "CardType": { "type": "string", "enum": [ "DEBIT", "CREDIT", "PREPAID" ] }, "CardOrderIntentResponse": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Amount for card ordering" }, "fees": { "additionalProperties": { "$ref": "#/components/schemas/Quote" }, "deprecated": false, "description": "Fee quotes by type for card ordering. Available type values: FX, SURCHARGE, ATM, TRANSFER, SUBSCRIPTION, CARD_ISSUE, CARD_DELIVERY, CARD_MONTHLY_SERVICE, CARD_FX, CLOSURE, DORMANCY", "type": "object" }, "hash": { "type": "string", "deprecated": false, "description": "Security hash for order verification", "maxLength": 2147483647, "minLength": 0 }, "holderNameValidity": { "anyOf": [ { "$ref": "#/components/schemas/Invalid" }, { "$ref": "#/components/schemas/Valid" } ], "deprecated": false, "description": "Holder name validity check result" }, "remainingLimits": { "additionalProperties": { "type": "number", "format": "int32" }, "deprecated": false, "description": "Remaining limits by type", "type": "object" } }, "required": [ "amount", "fees", "hash", "holderNameValidity", "remainingLimits" ] }, "Invalid": { "type": "object", "properties": { "firstName": { "items": { "type": "string" }, "deprecated": false, "description": "First name validation errors", "type": "array" }, "lastName": { "items": { "type": "string" }, "deprecated": false, "description": "Last name validation errors", "type": "array" }, "maxLength": { "type": "number", "format": "int32", "deprecated": false, "description": "Maximum length allowed", "maxLength": 2147483647, "minLength": 0 }, "type": { "enum": [ "INVALID" ] } }, "required": [ "firstName", "lastName", "maxLength", "type" ] }, "Valid": { "type": "object", "properties": { "holderName": { "type": "string", "deprecated": false, "description": "Valid holder name", "maxLength": 2147483647, "minLength": 0 }, "type": { "enum": [ "VALID" ] } }, "required": [ "holderName", "type" ] }, "CardOrderIntentRequest": { "type": "object", "properties": { "cardDesignId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Card design ID to be used for the card", "maxLength": 2147483647, "minLength": 0 }, "customerId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer ID of member for whom the card is being ordered", "maxLength": 2147483647, "minLength": 0 }, "holderName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Card holder name. Optional, specify if member legal name doesn't fit length requirement or has special symbols" } }, "required": [ "cardDesignId", "customerId" ] }, "CardOrderResponse": { "type": "object", "properties": { "card": { "$ref": "#/components/schemas/Card", "deprecated": false, "description": "Ordered card details" } }, "required": [ "card" ] }, "CardOrderRequest": { "type": "object", "properties": { "cardDesignId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Card design ID to be used for the card", "maxLength": 2147483647, "minLength": 0 }, "cardName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Custom card name" }, "customerId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Customer ID of member for whom the card is being ordered", "maxLength": 2147483647, "minLength": 0 }, "fees": { "additionalProperties": { "$ref": "#/components/schemas/Quote" }, "deprecated": false, "description": "Fee quotes for card ordering (from intent)", "type": "object" }, "hash": { "type": "string", "deprecated": false, "description": "Security hash for order verification (from intent)", "maxLength": 2147483647, "minLength": 0 }, "holderName": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Card holder name. Optional, specify if member legal name doesn't fit length requirement or has special symbols" }, "sourceAccountId": { "type": "string", "format": "uuid", "deprecated": false, "description": "Account ID to bind card to", "maxLength": 2147483647, "minLength": 0 }, "spendingLimit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CardLimitsUpdateRequest", "deprecated": false, "description": "Spending" } ] } }, "required": [ "cardDesignId", "customerId", "fees", "hash", "sourceAccountId" ] }, "CardLimitsUpdateRequest": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Monthly spending limit amount (required when name is MONTHLY, ignored for UNLIMITED)" } ] }, "name": { "$ref": "#/components/schemas/CardsSpendingLimitPolicyName", "deprecated": false, "description": "Spending limit policy name. MONTHLY for monthly limits, UNLIMITED for no limits" } }, "required": [ "name" ] }, "CardsSpendingLimitPolicyName": { "type": "string", "enum": [ "UNLIMITED", "MONTHLY" ] }, "CardProductResponse": { "type": "object", "properties": { "product": { "$ref": "#/components/schemas/CardProduct", "deprecated": false, "description": "Card product details" } }, "required": [ "product" ] }, "CardProduct": { "type": "object", "properties": { "conditions": { "items": { "$ref": "#/components/schemas/Condition" }, "deprecated": false, "description": "Product conditions", "maxItems": 2147483647, "minItems": 0, "type": "array" } }, "required": [ "conditions" ] }, "Condition": { "type": "object", "properties": { "cardIssuer": { "$ref": "#/components/schemas/CardIssuer", "deprecated": false, "description": "Issuer of the card" }, "cardType": { "$ref": "#/components/schemas/CardType", "deprecated": false, "description": "Card spending type" }, "code": { "type": "string", "deprecated": false, "description": "", "maxLength": 2147483647, "minLength": 0 }, "deliveryFee": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Delivery fee amount" } ] }, "formFactor": { "$ref": "#/components/schemas/FormFactor", "deprecated": false, "description": "Card form factor" }, "freeLimit": { "type": "number", "format": "int32", "deprecated": false, "description": "Number of free cards available", "maximum": 2147483647, "minimum": -2147483648 }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Condition id", "maxLength": 2147483647, "minLength": 0 }, "issueFee": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Issuing fee amount" } ] }, "totalLimit": { "type": "number", "format": "int32", "deprecated": false, "description": "Total number of cards available", "maximum": 2147483647, "minimum": -2147483648 }, "usage": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Usage", "deprecated": false, "description": "Usage info" } ] } }, "required": [ "cardIssuer", "cardType", "code", "formFactor", "freeLimit", "id", "totalLimit" ] }, "CardIssuer": { "type": "string", "enum": [ "WALLESTER", "MARQETA" ] }, "Usage": { "type": "object", "properties": { "number": { "type": "number", "format": "int32", "deprecated": false, "description": "Number of usages", "maximum": 2147483647, "minimum": -2147483648 } }, "required": [ "number" ] }, "ListCardDesignsResponse": { "type": "object", "properties": { "cardDesigns": { "items": { "$ref": "#/components/schemas/CardDesign" }, "deprecated": false, "description": "Available card designs", "type": "array" } }, "required": [ "cardDesigns" ] }, "SecurityResponse": { "type": "object", "properties": { "securityPolicy": { "$ref": "#/components/schemas/SecurityPolicy", "deprecated": false, "description": "Card security policy" } }, "required": [ "securityPolicy" ] }, "CardRenameRequest": { "type": "object", "properties": { "name": { "type": "string", "deprecated": false, "description": "New name for the card", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "name" ] }, "CardCredentialsUri": { "type": "object", "properties": { "uri": { "type": "string", "format": "URI", "deprecated": false, "description": "URI for card credentials", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "uri" ] }, "CardSetPinUri": { "type": "object", "properties": { "uri": { "type": "string", "format": "URI", "deprecated": false, "description": "URI for setting card PIN", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "uri" ] }, "CardPinUri": { "type": "object", "properties": { "uri": { "type": "string", "format": "URI", "deprecated": false, "description": "URI for getting card PIN", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "uri" ] }, "ListTransactions": { "type": "object", "properties": { "nextPage": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Next page value in base-64" }, "transactions": { "items": { "$ref": "#/components/schemas/Transaction" }, "deprecated": false, "description": "Transactions", "maxItems": 2147483647, "minItems": 0, "type": "array" } }, "required": [ "transactions" ] }, "Transaction": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/InternalTransactionCategory", "deprecated": false, "description": "Transaction category" }, "counterparty": { "$ref": "#/components/schemas/TransactionPart", "deprecated": false, "description": "Info on entity to which funds are moving" }, "date": { "$ref": "#/components/schemas/TxnDate", "deprecated": false, "description": "Time info on transaction states" }, "description": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Transaction reference" }, "direction": { "$ref": "#/components/schemas/TransactionDirection", "deprecated": false, "description": "Direction of funds moving" }, "fx": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Fx", "deprecated": false, "description": "Fx applied to transaction" } ] }, "id": { "type": "string", "format": "uuid", "deprecated": false, "description": "Transaction id", "maxLength": 2147483647, "minLength": 0 }, "origin": { "$ref": "#/components/schemas/TransactionPart", "deprecated": false, "description": "Info on entity from which funds are moving" }, "state": { "$ref": "#/components/schemas/TransactionState", "deprecated": false, "description": "Transaction status" }, "statusReason": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Transaction status explanation" }, "subtype": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Subtype of transaction type. E.g. CARD_REFUND, VAULT_WITHDRAWAL, etc" }, "type": { "$ref": "#/components/schemas/TransactionType", "deprecated": false, "description": "Transaction type" } }, "required": [ "category", "counterparty", "date", "direction", "id", "origin", "state", "type" ] }, "InternalTransactionCategory": { "type": "string", "enum": [ "CARD_PAYMENT", "SAVINGS", "INTERNAL_TRANSFER", "ATM", "EXTERNAL_TRANSFER", "OTHER" ] }, "TransactionPart": { "type": "object", "properties": { "account": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Account", "deprecated": false, "description": "Account info" } ] }, "acquiring": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AcquiringPart", "deprecated": false, "description": "Acquiring info" } ] }, "amount": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Total amount for this part" }, "amountWithoutFee": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Amount without fees applied" } ] }, "atm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AtmPart", "deprecated": false, "description": "ATM info" } ] }, "beneficiary": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Beneficiary", "deprecated": false, "description": "Beneficiary info" } ] }, "card": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CardPart", "deprecated": false, "description": "Card info" } ] }, "company": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyPart", "deprecated": false, "description": "Company info" } ] }, "crypto": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CryptoPart", "deprecated": false, "description": "Crypto info" } ] }, "customer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerProfile", "deprecated": false, "description": "Customer info" } ] }, "fees": { "oneOf": [ { "type": "null" }, { "additionalProperties": { "$ref": "#/components/schemas/Quote" }, "type": "object" } ], "deprecated": false, "description": "Applied fees" }, "goal": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GoalPart", "deprecated": false, "description": "Goal info" } ] }, "mcc": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MccPart", "deprecated": false, "description": "MCC info" } ] }, "merchant": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MerchantPart", "deprecated": false, "description": "Merchant info" } ] }, "payer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PayerPart", "deprecated": false, "description": "Payer info" } ] }, "totalFee": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Total fee for this part" } ] }, "type": { "$ref": "#/components/schemas/TransactionPartType", "deprecated": false, "description": "Type of entity involved in transaction" }, "vault": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VaultPart", "deprecated": false, "description": "Vault info" } ] } }, "required": [ "amount", "type" ] }, "AcquiringPart": { "type": "object", "properties": { "externalCardId": { "type": "string", "format": "uuid" } }, "required": [ "externalCardId" ] }, "AtmPart": { "type": "object", "properties": { "address": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "atmId": { "type": "string", "format": "uuid" } }, "required": [ "atmId" ] }, "CardPart": { "type": "object", "properties": { "cardId": { "type": "string", "format": "uuid" }, "lastFour": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "cardId" ] }, "CompanyPart": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" } }, "required": [ "branchId" ] }, "CryptoPart": { "type": "object", "properties": { "link": { "type": "string" }, "transactionHash": { "type": "string" } }, "required": [ "link", "transactionHash" ] }, "GoalPart": { "type": "object", "properties": { "collectedAmount": { "$ref": "#/components/schemas/Money" }, "createdAt": { "type": "string", "format": "Instant" }, "description": { "type": "string" }, "descriptionLink": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "goalOwnerId": { "type": "string", "format": "uuid" }, "goalOwnerType": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "picture": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "URI" } ] }, "sharingId": { "type": "string" }, "state": { "type": "string" }, "targetAmount": { "$ref": "#/components/schemas/Money" } }, "required": [ "collectedAmount", "createdAt", "description", "goalOwnerId", "goalOwnerType", "id", "name", "sharingId", "state", "targetAmount" ] }, "MccPart": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" } }, "required": [ "code", "description" ] }, "MerchantPart": { "type": "object", "properties": { "address": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "category": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "logo": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "URI" } ] }, "mcc": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "merchantId": { "type": "string", "format": "uuid" }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] } }, "required": [ "merchantId" ] }, "PayerPart": { "type": "object", "properties": { "accountNumber": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "bankName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "name": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "network": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "payerId": { "type": "string", "format": "uuid" }, "payerName": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "routingNumber": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "type": { "type": "string" } }, "required": [ "payerId", "type" ] }, "TransactionPartType": { "type": "string", "enum": [ "CUSTOMER", "COMPANY", "VAULT", "MERCHANT", "BENEFICIARY", "ATM", "ACQUIRING", "PAYER" ] }, "VaultPart": { "type": "object", "properties": { "vaultId": { "type": "string", "format": "uuid" } }, "required": [ "vaultId" ] }, "TxnDate": { "type": "object", "properties": { "created": { "type": "string", "format": "Instant" }, "processed": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant" } ] }, "settled": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant" } ] }, "started": { "type": "string", "format": "Instant" }, "updated": { "type": "string", "format": "Instant" } }, "required": [ "created", "started", "updated" ] }, "TransactionDirection": { "type": "string", "enum": [ "IN", "OUT" ] }, "TransactionState": { "type": "string", "enum": [ "PENDING", "COMPLETED", "FAILED" ] }, "TransactionType": { "type": "string", "enum": [ "CARD_ATM_WITHDRAWAL", "CARD_ATM_DEPOSIT", "CARD_PAYMENT", "CARD_DEPOSIT", "CARD_ACQUIRING", "OWN_TRANSFER", "INTERNAL_TRANSFER", "EXTERNAL_OUTGOING_TRANSFER", "EXTERNAL_INCOMING_TRANSFER", "INTERNAL_OUTGOING_TRANSFER", "INTERNAL_INCOMING_TRANSFER", "REWARD", "CASHBACK", "FEE", "REFUND" ] }, "TransactionSummary": { "type": "object", "properties": { "amountSpent": { "$ref": "#/components/schemas/Money", "deprecated": false, "description": "Total amount spent" }, "byCategory": { "additionalProperties": { "$ref": "#/components/schemas/Money" }, "deprecated": false, "description": "Amount spent by category", "type": "object" } }, "required": [ "amountSpent", "byCategory" ] }, "ListThreeDS": { "type": "object", "properties": { "threeDSs": { "items": { "$ref": "#/components/schemas/ThreeDS" }, "type": "array" } }, "required": [ "threeDSs" ] }, "ThreeDS": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/Money" }, "approvedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant" } ] }, "cardId": { "type": "string", "format": "uuid" }, "cardOwner": { "type": "string", "format": "uuid" }, "cardToken": { "type": "string" }, "createdAt": { "type": "string", "format": "Instant" }, "declineReason": { "oneOf": [ { "type": "null" }, { "type": "string" } ] }, "declinedAt": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Instant" } ] }, "id": { "type": "string", "format": "uuid" }, "lastFour": { "type": "string" }, "lifeTimeInSec": { "type": "number", "format": "int32" }, "merchantId": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "uuid" } ] }, "merchantInfo": { "$ref": "#/components/schemas/MerchantInfo" }, "publicUrl": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "URI" } ] }, "requestId": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "validUntil": { "type": "string", "format": "Instant" } }, "required": [ "amount", "cardId", "cardOwner", "cardToken", "createdAt", "id", "lastFour", "lifeTimeInSec", "merchantInfo", "requestId", "state", "type", "validUntil" ] }, "MerchantInfo": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/CountryCode" }, "mcc": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string", "format": "URI" } }, "required": [ "country", "mcc", "name", "uri" ] }, "OnrampResponse": { "type": "object", "properties": { "url": { "type": "string", "deprecated": false, "description": "Signed widget URL for crypto onramp", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "url" ] }, "OnrampRequest": { "type": "object", "properties": { "amountFrom": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Source amount to convert from (optional)" }, "amountTo": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Destination amount to receive (optional)" }, "cryptoAddress": { "type": "string", "deprecated": false, "description": "Cryptocurrency wallet address", "maxLength": 2147483647, "minLength": 0 }, "currencyFrom": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Currency", "deprecated": false, "description": "Source currency code (e.g. EUR, USD)", "maxLength": 2147483647, "minLength": 0 } ] }, "currencyTo": { "oneOf": [ { "type": "null" }, { "type": "string", "format": "Currency", "deprecated": false, "description": "Destination cryptocurrency code (e.g. BTC, ETH, USDC)", "maxLength": 2147483647, "minLength": 0 } ] }, "failureReturnUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "URL to redirect on failed transaction" }, "locale": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "Locale for widget UI (defaults to 'en')" }, "network": { "$ref": "#/components/schemas/CryptoTransferNetworkId", "deprecated": false, "description": "Blockchain network (e.g. ERC20, BEP20, POLYGON, SOLANA)" }, "successReturnUrl": { "oneOf": [ { "type": "null" }, { "type": "string" } ], "deprecated": false, "description": "URL to redirect on successful transaction" } }, "required": [ "cryptoAddress", "network" ] }, "ApiError": { "type": "object", "required": [ "errorCode", "name", "description" ], "properties": { "errorCode": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "integer" } } } } }, "securitySchemes": { "Bearer Authorization": { "type": "http", "scheme": "bearer" } } } }