--- updatedAt: 2026-04-14T09:21:28.000Z agentTools: projectIndex: https://developer.soldo.com/llms.txt --- # Get Wallet Endpoint to retrieve a specific `Wallet` by ID. ##### Required scopes: * `wallet_read` # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Soldo Business API v2.0 - OpenAPI 3.0", "description": "Soldo Business API v2.0 OpenAPI 3.0 specification", "version": "5.61.1" }, "servers": [ { "url": "https://api.soldo.com", "description": "Production server (using live data)" }, { "url": "https://api-demo.soldocloud.net", "description": "Sandbox server (using test data)" } ], "paths": { "/business/v2/wallets/{walletId}": { "get": { "tags": [ "Wallets" ], "summary": "Get Wallet", "description": "Endpoint to retrieve a specific `Wallet` by ID.", "operationId": "wallet-get", "parameters": [ { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string", "description": "The `Wallet` ID.", "example": "7bf79328-a7ae-4222-aa54-091ff7f429a7" } } ], "responses": { "200": { "description": "The returned resource is a single `Wallet`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wallet" } } } }, "404": { "description": "One or more resource requested does not exist." } }, "security": [ { "standardAuth": [ "wallet_read" ] } ] } } }, "components": { "schemas": { "ISO4217Currency": { "type": "string", "description": "The [ISO 4217](https://www.six-group.com/en/products-services/financial-information/data-standards.html#scrollTo=maintenance-agency) code of the currency of the `Wallet` (sortable: no)", "example": "EUR", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STD", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VEF", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "AccountInfoDeposit": { "type": "string", "description": "The `type` of account identification.", "example": "IBAN", "enum": [ "IBAN", "SISAL", "SORT_CODE", "ACCOUNT_NUMBER", "VIRTUAL_IBAN", "SHARED_SWIFT", "DEDICATED_SWIFT" ] }, "DepositAccountInfo": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccountInfoDeposit" }, "identification": { "type": "string", "description": "The account identification related to the type.", "example": "GB00ABCD00000123456789" } }, "description": "The deposit account info of the `Wallet`.", "example": [ "7bf79328-a7ae-4222-aa54-091ff7f429a7", "2d65bd5e-3fdf-4002-b166-bde7fb8863fa" ] }, "PrimaryUserType": { "type": "string", "description": "The type of resource assigned to the `Wallet`.", "example": "company", "enum": [ "main", "company", "employee", "dedicated" ] }, "Wallet": { "type": "object", "properties": { "id": { "type": "string", "description": "The `Wallet` ID (sortable: yes)", "example": "7bf79328-a7ae-4222-aa54-091ff7f429a7" }, "name": { "type": "string", "description": "The name of the `Wallet` (sortable: yes)", "example": "CompanyWallet1" }, "currency_code": { "$ref": "#/components/schemas/ISO4217Currency" }, "available_amount": { "type": "number", "description": "The currently available balance of the `Wallet` (sortable: no)", "example": 100 }, "blocked_amount": { "type": "number", "description": "The blocked balance of the `Wallet` (the overall amount of `Transactions` in `Authorised` status) (sortable: no)", "example": 0 }, "primary_user_type": { "$ref": "#/components/schemas/PrimaryUserType" }, "primary_user_public_id": { "type": "string", "description": "The ID of the `User` if the `Wallet` is of type `employee`, not available for other `Wallet` types (sortable: no)", "example": "XMPL1234-000001" }, "custom_reference_id": { "type": "string", "description": "The custom reference of the `User` if the `Wallet` is of type `employee`, not available for other wallet types (sortable: yes)", "example": "123456-usa-1" }, "group_id": { "type": "string", "description": "The ID of the `Group` the wallet is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility.", "example": "7bf79328-a7ae-4222-aa54-091ff7f429a7", "deprecated": true }, "groups": { "type": "array", "description": "The list of `Group` ID the wallet is related to (sortable: no)", "example": [ "7bf79328-a7ae-4222-aa54-091ff7f429a7", "2d65bd5e-3fdf-4002-b166-bde7fb8863fa" ], "items": { "type": "string", "description": "The list of `Group` ID the wallet is related to (sortable: no)", "example": "[\"7bf79328-a7ae-4222-aa54-091ff7f429a7\",\"2d65bd5e-3fdf-4002-b166-bde7fb8863fa\"]" } }, "label": { "type": "string", "description": "The label of the `Wallet` (sortable: yes)", "example": "CompanyWallet1" }, "visible": { "type": "boolean", "description": "It determines whether the `Wallet` is visible on the web console (sortable: yes)", "example": true }, "creation_time": { "type": "string", "description": "The date and time when the `Wallet` was created (sortable: yes)", "example": "2017-06-01T12:48:40Z" }, "last_update": { "type": "string", "description": "The date and time when the `Wallet` was last updated (sortable: yes)", "example": "2017-06-01T12:48:40Z" }, "deposit_account_info": { "type": "array", "description": "The deposit account info of the `Wallet`.", "example": [ "7bf79328-a7ae-4222-aa54-091ff7f429a7", "2d65bd5e-3fdf-4002-b166-bde7fb8863fa" ], "items": { "$ref": "#/components/schemas/DepositAccountInfo" } }, "description": { "type": "string", "description": "The note of the `Wallet` (sortable: yes)", "example": "CompanyWallet1" } } } }, "securitySchemes": { "standardAuth": { "type": "oauth2", "description": "This API uses OAuth 2 with the \"Client Credentials\" grant flow.", "flows": { "clientCredentials": { "tokenUrl": "https://api.soldo.com/oauth/authorize", "scopes": { "address_read": "Can read address details.", "address_write": "Can update address details.", "card_read": "Can read card details.", "card_write": "Can change card details.", "company_read": "Can read company details.", "company_write": "Can change company details.", "contact_read": "Can read contact details.", "contact_write": "Can change contact details.", "employee_read": "Can read employee details.", "employee_write": "Can change employee details.", "expense_category_read": "Can read expense category details.", "expense_category_write": "Can change expense category details.", "expense_report_read": "Can read expense report details.", "expense_report_write": "Can change expense report details.", "expense_review_read": "Can read expense review status.", "expense_review_write": "Can change expense review status.", "group_read": "Can read group details.", "group_write": "Can change groups details.", "online_ads_read": "Can read online ads details.", "online_ads_write": "Can change online ads details.", "payment_read": "Can read payment details.", "payment_write": "Can change payment details.", "purchase_read": "Can read purchase details.", "purchase_write": "Can change purchase details.", "refueling_read": "Can read refueling details.", "refueling_write": "Can change refueling details.", "resource_set_read": "Can read resource set details.", "resource_set_write": "Can change resource set details.", "role_read": "Can read role details.", "statement_read": "Can read statement details.", "subscription_read": "Can read subscription details.", "subscription_write": "Can change subscription details.", "tag_read": "Can read tags.", "tag_write": "can change tags.", "tax_rate_read": "Can read vat rate details.", "tax_rate_write": "Can change vat rate details.", "transaction_read": "Can read transaction details.", "transaction_write": "Can change transaction details.", "vehicle_read": "Can read vehicle details.", "vehicle_write": "Can change vehicle details.", "wallet_read": "Can read wallet details.", "wallet_write": "Can change wallet details.", "webhook_subscription_read": "Can read webhook subscription details.", "webhook_subscription_write": "Can change webhook subscription details." } } } } } }, "x-webhooks": { "move_resources_card": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Move Resources Card", "description": "A `Card` has been moved to another `Group`.", "operationId": "webhook-group-move-resources-card", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveResourcesCardEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "move_resources_wallet": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Move Resources Wallet", "description": "A `Wallet` is moved to another `Group`.", "operationId": "webhook-group-move-resources-wallet", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveResourcesWalletEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "customer_care_withdraw": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Customer Care Withdraw", "description": "A `Withdrawal` has been performed by customer care support", "operationId": "webhook-transaction-customer-care-withdraw", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCareWithdrawEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "transaction_business_trip_unlinked": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Transaction Business Trip Unlinked", "description": "A `Transaction` has been unlinked from a `BusinessTrip`.", "operationId": "webhook-transaction-transaction-business-trip-unlinked", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBusinessTripUnlinkedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "remove_resources_card": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Remove Resources Card", "description": "A `Card` has been removed from a `Group`.", "operationId": "webhook-group-remove-resources-card", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveResourcesCardEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "load_failed": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Load Failed", "description": "A money load for company `Wallet` failed.", "operationId": "webhook-transaction-load-failed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadFailedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "created_expense_configuration": { "post": { "tags": [ "Webhooks", "Expense Review Configuration" ], "summary": "Expense Review - Configuration Created", "description": "An `ExpenseReview` configuration has been created`.", "operationId": "webhook-expensereview-created-expense-configuration", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedExpenseConfigurationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "change_expense_type": { "post": { "tags": [ "Webhooks", "Expense Reviews" ], "summary": "Expense Review - Change Expense Type", "description": "A `Transaction` expense type has been changed.", "operationId": "webhook-expensereview-change-expense-type", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeExpenseTypeEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "move_resources_member": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Move Resources Member", "description": "An `User` is moved to another `Group`.", "operationId": "webhook-group-move-resources-member", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveResourcesMemberEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "purchase_redeem_card": { "post": { "tags": [ "Webhooks", "Pre-approved Spend" ], "summary": "Pre-Approved Spend - Purchase Redeem Card", "description": "A `Card` of purchase has been redeemed.", "operationId": "webhook-preapprovedspend-purchase-redeem-card", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, title, description, amount, amountCurrency", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, title, description, amount, amountCurrency" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseRedeemCardEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, title, description, amount, amountCurrency" } } }, "billing": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Billing", "description": "Billing related to `Card` purchase.", "operationId": "webhook-transaction-billing", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "customer_care_deposit": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Customer Care Deposit", "description": "A `Deposit` has been performed by customer care support.", "operationId": "webhook-transaction-customer-care-deposit", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCareDepositEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "inter_account_transfer": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Inter Account Transfer", "description": "A Transfer between `Wallets` belonging to different Accounts.", "operationId": "webhook-transaction-inter-account-transfer", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterAccountTransferEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "store_order_completed": { "post": { "tags": [ "Webhooks", "Orders" ], "summary": "Order - Store Order Completed", "description": "An `Order` has been completed.", "operationId": "webhook-order-store-order-completed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreOrderCompletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, status" } } }, "card_lost": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Lost", "description": "A `Card` has been reported as lost.", "operationId": "webhook-card-card-lost", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLostEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "inbound_payment_reversal": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Inbound Payment Reversal", "description": "Reversal of an inbound payment from Faster Payment", "operationId": "webhook-transaction-inbound-payment-reversal", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundPaymentReversalEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "new_user": { "post": { "tags": [ "Webhooks", "Users" ], "summary": "User - New User", "description": "A new `User` has been created.", "operationId": "webhook-user-new-user", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, surname, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, surname, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, surname, status" } } }, "updated_expense_configuration": { "post": { "tags": [ "Webhooks", "Expense Review Configuration" ], "summary": "Expense Review - Updated Expense Configuration", "description": "An `ExpenseReview` configuration is updated.", "operationId": "webhook-expensereview-updated-expense-configuration", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedExpenseConfigurationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "scheduled_transfer": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Scheduled Transfer", "description": "Failed scheduled internal transfer to top-up a `Wallet`.", "operationId": "webhook-transaction-scheduled-transfer", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledTransferEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "transaction_modified": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Transaction Modified", "description": "A `Transaction` has been modified, e.g. moved to another `Wallet` or changed in other describing attributes.", "operationId": "webhook-transaction-transaction-modified", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionModifiedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "card_change_status": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Change Status", "description": "A `Card` changed status.", "operationId": "webhook-card-card-change_status", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardChangeStatusEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "online_ads_updated": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Updated", "description": "An `OnlineAds` has been updated.", "operationId": "webhook-onlineads-online-ads-updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "delete_group": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Group Deleted", "description": "A`Group` has been deleted.", "operationId": "webhook-group-delete-group", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGroupEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "load_money": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Load Money", "description": "A money load on company `Wallet` succeeded.", "operationId": "webhook-transaction-load-money", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadMoneyEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "wiretransfer": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Wiretransfer", "description": "Deposit in.", "operationId": "webhook-transaction-wiretransfer", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WiretransferEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "contact_deleted": { "post": { "tags": [ "Webhooks", "Contacts" ], "summary": "Contact - Contact Deleted", "description": "A `Contact` has been deleted.", "operationId": "webhook-contact-contact-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, userId, type, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, userId, type, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, userId, type, status" } } }, "card_destroyed": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Destroyed", "description": "A `Card` has been destroyed.", "operationId": "webhook-card-card-destroyed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDestroyedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "card_authorization": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Card Authorization", "description": "A `Transaction` authorisation has been requested.", "operationId": "webhook-transaction-card-authorization", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardAuthorizationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "updated_transaction": { "post": { "tags": [ "Webhooks", "Expense Reviews" ], "summary": "Expense Review - Updated Transaction", "description": "A `Transaction` has been update.", "operationId": "webhook-expensereview-updated-transaction", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedTransactionEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "transaction_adjustment": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Transaction Adjustment", "description": "A `Transaction` has been adjusted.", "operationId": "webhook-transaction-transaction-adjustment", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionAdjustmentEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "attachment_delete": { "post": { "tags": [ "Webhooks", "Transaction Attachments" ], "summary": "Transaction Attachment - Attachment Delete", "description": "An attachment has been deleted from a `Transaction`.", "operationId": "webhook-transactionattachment-attachment-delete", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "attachmentId, transactionId, fileName", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "attachmentId, transactionId, fileName" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentDeleteEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "attachmentId, transactionId, fileName" } } }, "disabled_expense_configuration": { "post": { "tags": [ "Webhooks", "Expense Review Configuration" ], "summary": "Expense Review - Configuration Disabled", "description": "An `ExpenseReview` configuration has been disabled.", "operationId": "webhook-expensereview-disabled-expense-configuration", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisabledExpenseConfigurationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "purchase_delete": { "post": { "tags": [ "Webhooks", "Pre-approved Spend" ], "summary": "Pre-Approved Spend - Purchase Delete", "description": "A `Purchase` has been deleted.", "operationId": "webhook-preapprovedspend-purchase-delete", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, title, description, amount, amountCurrency", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, title, description, amount, amountCurrency" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseDeleteEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, title, description, amount, amountCurrency" } } }, "wallet_created": { "post": { "tags": [ "Webhooks", "Wallets" ], "summary": "Wallet - Wallet Created", "description": "A new `Wallet` has been created.", "operationId": "webhook-wallet-wallet-created", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, currencyCode, primaryUserPublicId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, currencyCode, primaryUserPublicId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletCreatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, currencyCode, primaryUserPublicId" } } }, "card_activated": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Activated", "description": "A `Card` has been activated.", "operationId": "webhook-card-card-activated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardActivatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "unload_money": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Unload Money", "description": "Unload money from a company `Wallet`.", "operationId": "webhook-transaction-unload-money", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnloadMoneyEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "create_group": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Group Created", "description": "A new `Group` has been created.", "operationId": "webhook-group-create-group", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "update_group": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Update Group", "description": "A `Group` has been updated.", "operationId": "webhook-group-update-group", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGroupEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "user_updated": { "post": { "tags": [ "Webhooks", "Users" ], "summary": "User - User Updated", "description": "An `User` has been updated.", "operationId": "webhook-user-user-updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, surname, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, surname, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, surname, status" } } }, "subscription_assignee_added": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Assignee Added", "description": "A `Subscription` assignee is added.", "operationId": "webhook-subscription-subscription-assignee-added", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAssigneeAddedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } }, "inbound_payment": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Inbound Payment", "description": "Inbound payment from Faster Payment", "operationId": "webhook-transaction-inbound-payment", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundPaymentEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "joule_feed": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Joule Feed", "description": "A `Transaction` has been settled/reversed.", "operationId": "webhook-transaction-joule-feed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JouleFeedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "transaction_business_trip_linked": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Transaction Business Trip Linked", "description": "A `Transaction` has been linked to a `BusinessTrip`.", "operationId": "webhook-transaction-transaction-business-trip-linked", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionBusinessTripLinkedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "transaction_deleted": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Transaction Deleted", "description": "A `Transaction` has been deleted. This may happen only for `OUT_OF_PLATFORM_COMPANY` or `OUT_OF_PLATFORM_PERSONAL` transactions.", "operationId": "webhook-transaction-transaction-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "vehicle_create": { "post": { "tags": [ "Webhooks", "Vehicles" ], "summary": "Vehicle - Vehicle Create", "description": "A `Vehicle` has been created.", "operationId": "webhook-vehicle-vehicle-create", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id,numberPlate", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id,numberPlate" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleCreateEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id,numberPlate" } } }, "card_replaced": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Replaced", "description": "A `Card` has been replaced.", "operationId": "webhook-card-card-replaced", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardReplacedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "card_stolen": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Stolen", "description": "A `Card` has been reported as stolen.", "operationId": "webhook-card-card-stolen", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardStolenEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "card_creation": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Creation", "description": "A new `Card` has been created.", "operationId": "webhook-card-card-creation", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, status, walletId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardCreationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "add_resources_card": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Add Resources Card", "description": "A `Card` has been added to a `Group`.", "operationId": "webhook-group-add-resources-card", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddResourcesCardEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "online_ads_created": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Created", "description": "An `OnlineAds` has been created.", "operationId": "webhook-onlineads-online-ads-created", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsCreatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "vehicle_delete": { "post": { "tags": [ "Webhooks", "Vehicles" ], "summary": "Vehicle - Vehicle Delete", "description": "A `Vehicle` has been deleted.", "operationId": "webhook-vehicle-vehicle-delete", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id,numberPlate", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id,numberPlate" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleDeleteEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id,numberPlate" } } }, "remove_resources_member": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Remove Resources Member", "description": "An `User` has been removed from a `Group`.", "operationId": "webhook-group-remove-resources-member", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveResourcesMemberEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "inter_account_transfer_recurring_billing": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Inter Account Transfer Recurring Billing", "description": "A Transfer between `Wallets` belonging to different Accounts for a recurring billing.", "operationId": "webhook-transaction-inter-account-transfer-recurring-billing", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterAccountTransferRecurringBillingEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "subscription_created": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Created", "description": "A `Subscription` has been created.", "operationId": "webhook-subscription-subscription-created", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionCreatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } }, "add_resources_wallet": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Add Resources Wallet", "description": "A `Wallet` has been added to a `Group`.", "operationId": "webhook-group-add-resources-wallet", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddResourcesWalletEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "balanced_transfer": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Balanced Transfer", "description": "Failed balanced internal transfer to top-up a `Wallet`.", "operationId": "webhook-transaction-balanced-transfer", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalancedTransferEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "refueling_updated": { "post": { "tags": [ "Webhooks", "Refueling Transactions" ], "summary": "Refueling - Refueling Updated", "description": "A `Refueling` has been updated.", "operationId": "webhook-refueling-refueling-updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefuelingUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } } }, "vehicle_update": { "post": { "tags": [ "Webhooks", "Vehicles" ], "summary": "Vehicle - Vehicle Update", "description": "A `Vehicle` has been updated.", "operationId": "webhook-vehicle-vehicle-update", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id,numberPlate", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id,numberPlate" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleUpdateEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id,numberPlate" } } }, "online_ads_activated": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Activated", "description": "An `OnlineAds` has been activated.", "operationId": "webhook-onlineads-online-ads-activated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsActivatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "refueling_deleted": { "post": { "tags": [ "Webhooks", "Refueling Transactions" ], "summary": "Refueling - Refueling Deleted", "description": "A `Refueling` has been deleted.", "operationId": "webhook-refueling-refueling-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefuelingDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } } }, "card_label_updated": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Update Label", "description": "A label `Card` has been updated label.", "operationId": "webhook-card-card_label_updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id,label,token", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardLabelUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "subscription_deleted": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Deleted", "description": "A `Subscription` has been deleted.", "operationId": "webhook-subscription-subscription-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } }, "recurring_billing": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Recurring Billing", "description": "Monthly billing.", "operationId": "webhook-transaction-recurring-billing", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecurringBillingEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "upload_completed": { "post": { "tags": [ "Webhooks", "Transaction Attachments" ], "summary": "Transaction Attachment - Upload Completed", "description": "An attachment is uploaded to a `Transaction`.", "operationId": "webhook-transactionattachment-upload-completed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "attachmentId, transactionId, fileName", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "attachmentId, transactionId, fileName" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadCompletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "attachmentId, transactionId, fileName" } } }, "subscription_updated": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Updated", "description": "A `Subscription` has been updated.", "operationId": "webhook-subscription-subscription-updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } }, "online_ads_deleted": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Deleted", "description": "An `OnlineAds` has been deleted.", "operationId": "webhook-onlineads-online-ads-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "conversion": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Conversion", "description": "A transfer between `Wallets` with different currencies.", "operationId": "webhook-transaction-conversion", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversionEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "refueling_created": { "post": { "tags": [ "Webhooks", "Refueling Transactions" ], "summary": "Refueling - Refueling Created", "description": "A `Refueling` has been created.", "operationId": "webhook-refueling-refueling-created", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefuelingCreatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, transactionId, cardId, vehicleId, mileage, quantity, unitPrice, txFuelType" } } }, "edit_tag": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Tag Edited", "description": "A `Tag` has been added or removed from a `Transaction`.", "operationId": "webhook-transaction-edit-tag", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditTagEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "contact_updated": { "post": { "tags": [ "Webhooks", "Contacts" ], "summary": "Contact - Contact Updated", "description": "A `Contact` has been updated.", "operationId": "webhook-contact-contact-updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, userId, type, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, userId, type, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, userId, type, status" } } }, "online_ads_assignee_added": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Assignee Added", "description": "An `OnlineAds` assignee has been added.", "operationId": "webhook-onlineads-online-ads-assignee-added", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsAssigneeAddedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "purchase_update": { "post": { "tags": [ "Webhooks", "Pre-approved Spend" ], "summary": "Pre-Approved Spend - Purchase Update", "description": "A `Purchase` has been updated.", "operationId": "webhook-preapprovedspend-purchase-update", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, title, description, amount, amountCurrency", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, title, description, amount, amountCurrency" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseUpdateEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, title, description, amount, amountCurrency" } } }, "online_ads_assignee_removed": { "post": { "tags": [ "Webhooks", "Online Ads" ], "summary": "OnlineAds - OnlineAds Assignee Removed", "description": "An `OnlineAds` assignee has been removed.", "operationId": "webhook-onlineads-online-ads-assignee-removed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, walletId, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, walletId, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineAdsAssigneeRemovedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, walletId, cardId" } } }, "wallet_deleted": { "post": { "tags": [ "Webhooks", "Wallets" ], "summary": "Wallet - Wallet Deleted", "description": "A `Wallet` has been deleted.", "operationId": "webhook-wallet-wallet-deleted", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, currencyCode, primaryUserPublicId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, currencyCode, primaryUserPublicId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletDeletedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, currencyCode, primaryUserPublicId" } } }, "remove_resources_wallet": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Remove Resources Wallet", "description": "A `Wallet` is removed from a `Group`.", "operationId": "webhook-group-remove-resources-wallet", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveResourcesWalletEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "enabled_expense_configuration": { "post": { "tags": [ "Webhooks", "Expense Review Configuration" ], "summary": "Expense Review - Configuration Enabled", "description": "An `ExpenseReview` configuration has been enabled.", "operationId": "webhook-expensereview-enabled-expense-configuration", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnabledExpenseConfigurationEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "completed_transactions_import": { "post": { "tags": [ "Webhooks", "Expense Reviews" ], "summary": "Expense Review - Transaction Import Completed", "description": "A `Transaction` import has been completed.", "operationId": "webhook-expensereview-completed-transactions-import", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "startDate, policyUrl, enabled, transactionId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "startDate, policyUrl, enabled, transactionId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTransactionsImportEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "startDate, policyUrl, enabled, transactionId" } } }, "store_order_placed": { "post": { "tags": [ "Webhooks", "Orders" ], "summary": "Order - Store Order Placed", "description": "An `Order` has been placed.", "operationId": "webhook-order-store-order-placed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreOrderPlacedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, status" } } }, "purchase_create": { "post": { "tags": [ "Webhooks", "Pre-approved Spend" ], "summary": "Pre-Approved Spend - Purchase Create", "description": "A `Purchase` has been created.", "operationId": "webhook-preapprovedspend-purchase-create", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, title, description, amount, amountCurrency", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, title, description, amount, amountCurrency" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseCreateEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, title, description, amount, amountCurrency" } } }, "subscription_assignee_removed": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Assignee Removed", "description": "A `Subscription` assignee is removed.", "operationId": "webhook-subscription-subscription-assignee-removed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionAssigneeRemovedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } }, "contact_created": { "post": { "tags": [ "Webhooks", "Contacts" ], "summary": "Contact - Contact Created", "description": "A `Contact` has been created.", "operationId": "webhook-contact-contact-created", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, userId, type, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, userId, type, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, userId, type, status" } } }, "add_resources_member": { "post": { "tags": [ "Webhooks", "Groups" ], "summary": "Group - Add Resources Member", "description": "An `User` has been added to a `Group`.", "operationId": "webhook-group-add-resources-member", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, type, customReferenceId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, type, customReferenceId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddResourcesMemberEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, type, customReferenceId" } } }, "internal_transfer": { "post": { "tags": [ "Webhooks", "Transactions" ], "summary": "Transaction - Internal Transfer", "description": "A Transfer between `Wallets` with the same currency", "operationId": "webhook-transaction-internal-transfer", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, walletId, status, transactionSign", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, walletId, status, transactionSign" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalTransferEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, walletId, status, transactionSign" } } }, "card_assignee_updated": { "post": { "tags": [ "Webhooks", "Cards" ], "summary": "Card - Card Update Assignee", "description": "A label `Card` has been updated assignee.", "operationId": "webhook-card-card_assignee_updated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id,join(addCardAssignees),join(removeCardAssignees),token", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, status, walletId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardAssigneeUpdatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, status, walletId" } } }, "user_status_changed": { "post": { "tags": [ "Webhooks", "Users" ], "summary": "User - User Status Changed", "description": "The status of a `User` changed.", "operationId": "webhook-user-user-status-changed", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, surname, status", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, surname, status" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatusChangedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, surname, status" } } }, "subscription_activated": { "post": { "tags": [ "Webhooks", "Subscriptions" ], "summary": "Subscription - Subscription Activated", "description": "A `Subscription` has been activated.", "operationId": "webhook-subscription-subscription-activated", "parameters": [ { "name": "X-Soldo-Fingerprint", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): `SHA512SUM` of the fingerprint values listed in the fingerprint order for this webhook.", "example": "{{fingerprint}}" } }, { "name": "X-Soldo-Fingerprint-Order", "in": "header", "required": true, "schema": { "type": "string", "default": "id, name, platform, status, paymentFrequency, cardId", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): The order of the values used to calculate the fingerprint.", "example": "id, name, platform, status, paymentFrequency, cardId" } }, { "name": "X-Soldo-Fingerprint-Signature", "in": "header", "required": true, "schema": { "type": "string", "default": "{{fingerprint_signature}}", "description": "[Webhook authentication](https://developer.soldo.com/reference/webhook-authentication): Signature of the `X-Soldo-Fingerprint`. It must be verified using the [Soldo public key](https://developer.soldo.com/reference/soldo-public-key).", "example": "{{fingerprint_signature}}" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionActivatedEvent" } } } }, "responses": { "200": { "description": "Success." } }, "x-soldo": { "fingerprint-order": "id, name, platform, status, paymentFrequency, cardId" } } } }, "x-readme": { "hidden": true } } ```