# Accounts

## GET /api/v1/accounts

> List of active accounts in organization

```json
{"openapi":"3.0.3","info":{"title":"Dashboard API","version":"1.0.0"},"tags":[{"name":"accounts"}],"paths":{"/api/v1/accounts":{"get":{"summary":"List of active accounts in organization","tags":["accounts"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"baseCurrency":{"type":"string"},"aggregatedBalance":{"anyOf":[{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+$"},"asset":{"type":"string","minLength":1,"maxLength":16},"scale":{"type":"integer","minimum":0,"maximum":18}},"required":["amount","asset","scale"],"additionalProperties":false},{"nullable":true,"enum":[null]}]},"isReadOnly":{"type":"boolean"}},"required":["id","name","baseCurrency","aggregatedBalance","isReadOnly"],"additionalProperties":false}}},"required":["records"],"additionalProperties":false}}}}}}}}}
```

## GET /api/v1/accounts/{accountId}

> Get account

```json
{"openapi":"3.0.3","info":{"title":"Dashboard API","version":"1.0.0"},"tags":[{"name":"accounts"}],"paths":{"/api/v1/accounts/{accountId}":{"get":{"summary":"Get account","tags":["accounts"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"accountId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"baseCurrency":{"type":"string"},"aggregatedBalance":{"anyOf":[{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+$"},"asset":{"type":"string","minLength":1,"maxLength":16},"scale":{"type":"integer","minimum":0,"maximum":18}},"required":["amount","asset","scale"],"additionalProperties":false},{"nullable":true,"enum":[null]}]},"isReadOnly":{"type":"boolean"}},"required":["id","name","baseCurrency","aggregatedBalance","isReadOnly"],"additionalProperties":false}}}}}}}}}
```

## GET /api/v1/accounts/{accountId}/payment-instructions

> Get available payment instructions for account

```json
{"openapi":"3.0.3","info":{"title":"Dashboard API","version":"1.0.0"},"tags":[{"name":"accounts"}],"paths":{"/api/v1/accounts/{accountId}/payment-instructions":{"get":{"summary":"Get available payment instructions for account","tags":["accounts"],"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"accountId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"type":{"type":"string","enum":["CRYPTO","FIAT"]},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"asset":{"type":"string"},"rail":{"anyOf":[{"type":"string","enum":["ETHEREUM","TRON","BASE","POLYGON"]},{"nullable":true,"enum":[null]}]},"paymentIdentifiers":{"type":"array","items":{"type":"object","properties":{"id":{"anyOf":[{"type":"string"},{"nullable":true,"enum":[null]}]},"type":{"type":"string","enum":["BSB","AU_ACCOUNT_NUMBER","IBAN","WALLET_ADDRESS","MEMO","ACCOUNT_NUMBER","ABA_ROUTING_NUMBER","SORT_CODE","SWIFT_BIC","BANK_NAME","BANK_ADDRESS","BANK_CITY","BANK_POSTAL_CODE","TRANSFER_DESCRIPTION_MATCH_TOKEN","PROVIDER_ACCOUNT_ID","ACCOUNT_HOLDER_NAME"]},"value":{"anyOf":[{"type":"string"},{"nullable":true,"enum":[null]}]},"active":{"anyOf":[{"type":"boolean"},{"nullable":true,"enum":[null]}]},"sequenceNumber":{"anyOf":[{"type":"string"},{"nullable":true,"enum":[null]}]},"amount":{"anyOf":[{"type":"number"},{"nullable":true,"enum":[null]}]},"usdAmount":{"anyOf":[{"type":"number"},{"nullable":true,"enum":[null]}]},"complete":{"anyOf":[{"type":"boolean"},{"nullable":true,"enum":[null]}]},"providerId":{"anyOf":[{"type":"string"},{"nullable":true,"enum":[null]}]}},"required":["type"],"additionalProperties":false}},"isReadOnly":{"type":"boolean"},"thirdPartyDisabled":{"type":"boolean"},"balance":{"anyOf":[{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+$"},"asset":{"type":"string","minLength":1,"maxLength":16},"scale":{"type":"integer","minimum":0,"maximum":18}},"required":["amount","asset","scale"],"additionalProperties":false},{"nullable":true,"enum":[null]}]},"topUpBillingEnabled":{"type":"boolean"},"minimumAmount":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+$"},"asset":{"type":"string","minLength":1,"maxLength":16},"scale":{"type":"integer","minimum":0,"maximum":18}},"required":["amount","asset","scale"],"additionalProperties":false},"fixedFee":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+$"},"asset":{"type":"string","minLength":1,"maxLength":16},"scale":{"type":"integer","minimum":0,"maximum":18}},"required":["amount","asset","scale"],"additionalProperties":false},"percentageFee":{"type":"number"}},"required":["id","type","status","asset","rail","paymentIdentifiers","isReadOnly","thirdPartyDisabled","balance"],"additionalProperties":false}}},"required":["records"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["undefined","unauthorized","unprocessable_entity","not_found","already_exists","bad_request","conflict","forbidden","internal_server_error","validation_error","missing_permissions","unexpected_error","limit_reached","not_implemented","account_not_found","auth_invalid_api_key","auth_invalid_token","auth_missing_api_key","auth_missing_authorization","auth_missing_employee_header","auth_invalid_employee_header","auth_missing_idempotency_key","custom_asset_not_found","custom_asset_referenced_by_operations","custom_asset_symbol_already_active","custom_asset_symbol_conflict_builtin","custom_asset_symbol_previously_deleted","asset_unknown_symbol","asset_unsupported","dfns_multiple_assets_found","dfns_unsupported_asset","dfns_unsupported_network","dfns_webhook_signature_invalid","dfns_operational_wallet_already_exists","dfns_operational_wallet_not_found","external_contact_has_accounts","external_contact_not_found","hercle_api_error","hercle_balance_not_found","hercle_deposit_account_details_invalid","hercle_deposit_account_details_not_found","hercle_deposit_address_not_found","hercle_inbound_transaction_not_found","hercle_not_initialized","hercle_pair_not_found","hercle_payee_address_not_found","hercle_payee_not_found","hercle_transaction_already_matched","hercle_transfer_not_found","idempotency_missing_key","idempotency_key_too_long","idempotency_key_in_progress","idempotency_hash_mismatch","hpp_invalid_action","hpp_no_available_virtual_iban","hpp_payment_request_locked","hpp_sender_verification_incomplete","identity_not_found","identity_deactivated","identity_missing_payment_instruction","identity_provider_id_not_found","identity_account_not_found","identity_account_deactivated","identity_account_cannot_activate_deactivated_identity","identity_account_cannot_deactivate_non_external","identity_account_creation_failed","identity_account_missing_payment_instruction","identity_account_invalid_wallet_address","identity_account_missing_payment_identifier","invoice_not_found","invoice_upload_not_found","invoice_upload_access_denied","invoice_file_too_large","invoice_file_type_not_allowed","kyt_already_approved","kyt_invalid_transaction_type","kyt_manual_decision_already_made","kyt_transaction_not_found","kyt_unsupported_workflow_type","ledger_lock_exists","ledger_lock_held_by_another","ledger_insufficient_fund","ledger_address_invalid","ledger_asset_not_found","ledger_balance_locked","ledger_invalid_asset_format","ledger_not_implemented","ledger_transaction_conflict","ledger_transaction_validation_error","ledger_unsupported_payment_system","mail_step_up_verification_failed","mail_step_up_operation_not_found","manual_operation_not_found","manual_operation_duplicate_pi_key","manual_operation_insufficient_funds","manual_operation_invalid_pi_type","manual_operation_missing_own_identity","manual_operation_organization_link_inactive","manual_operation_pi_missing_account","manual_operation_pi_missing_wallet_provider","manual_operation_pi_not_found","manual_operation_posting_validation_error","manual_operation_unknown_asset","manual_operation_invalid_status_transition","manual_operation_invalid_transacting_entity","manual_operation_pi_missing_identity_account","manual_operation_pi_missing_identifier","manual_operation_amount_not_resolved","manual_operation_organization_link_invalid","manual_operation_self_transfer_forbidden","manual_operation_asset_mismatch","manual_operation_amount_mismatch","mep_missing_rail_id","mep_unsupported_crypto","onboarding_not_found","organization_not_found","organization_missing_own_identity","organization_missing_own_identity_email","billing_config_not_found","billing_invalid_asset","billing_invalid_spread_same_currency","organization_link_not_found","organization_link_already_exists","organization_link_already_deactivated","organization_link_self_link_forbidden","payment_instruction_not_found","payment_instruction_account_mismatch","payment_instruction_asset_mismatch","payment_instruction_conflict","payment_instruction_duplicate_identifier","payment_instruction_missing_wallet","payment_instruction_not_fiat","payment_request_not_found","payment_request_already_completed","payment_request_already_has_invoice","payment_request_contact_deactivated","payment_request_contact_not_verified","payment_request_escrow_release_condition_required","payment_request_has_pending_transactions","payment_request_identity_not_external","payment_request_invalid_status_for_completion","payment_request_invoice_not_uploaded","payment_request_no_matching_billing_instruments","payment_request_release_condition_not_allowed","payment_request_amount_exceeds_limit","payment_request_transaction_amount_mismatch","payment_request_transaction_not_found","payout_not_found","payout_amounts_empty","payout_deactivated_contact","payout_deactivated_identity_account","payout_destination_pi_not_found","payout_fx_quote_not_found","payout_invalid_destination_asset","payout_invalid_source_asset","payout_payment_not_confirmed","payout_source_pi_not_found","payout_transaction_not_found","payout_validation_error","unsupported_payout_option","disabled_payout_option","payment_not_confirmed","quote_fx_calculation_error","quote_invalid_source_asset","quote_no_matching_billing_instruments","reconciliation_cancel_failed","reconciliation_result_not_found","reconciliation_run_already_active","reconciliation_run_already_terminal","reconciliation_run_not_found","reconciliation_unknown_rail_type","redis_lock_creation_failed","slack_api_error","sumsub_api_error","sumsub_applicant_already_exists","sumsub_invalid_digest","sumsub_missing_identity_provider_id","sumsub_payment_method_already_exists","sumsub_transaction_already_exists","sumsub_unsupported_chain","sumsub_unsupported_currency","sumsub_unsupported_payment_method","sumsub_validation_error","token_invalid","token_not_found","token_missing_permissions","topup_amount_verification_failed","topup_fee_processing_failed","topup_transaction_not_found","transaction_not_found","user_not_found","user_not_in_organization","user_role_not_found","user_cannot_delete_self","user_cannot_modify_admin","user_force_logout_failed","user_insufficient_permissions","user_invitation_config_error","user_invitation_conflict","user_invitation_failed","user_mfa_enrollment_failed","user_password_reset_failed","virtual_account_not_found","wallet_adapter_not_found","wallet_balance_insufficient","wallet_fee_sponsor_not_found","wallet_not_on_dfns","webhook_not_found","webhook_limit_reached","unsupported_webhook_type","workflow_invalid_type","workflow_signal_error","yellow_card_api_error","yellow_card_chunk_limit_exceeded","yellow_card_settlement_timeout","yellow_card_settlement_verification_failed","yellow_card_webhook_signature_invalid","courier_socket_not_initialized","dynamic_config_not_exists","unsupported_option_provided","unsupported_identifier_provided","required_identifier_missing"]},"message":{"type":"string"},"details":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"requestId":{"type":"string"},"timestamp":{"type":"string"},"issues":{"type":"object","additionalProperties":{}}},"required":["url","method","requestId","timestamp"],"additionalProperties":false}},"required":["code","message","details"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}}}}
```

## PATCH /api/v1/accounts/{accountId}/name

> Update account name

```json
{"openapi":"3.0.3","info":{"title":"Dashboard API","version":"1.0.0"},"tags":[{"name":"accounts"}],"paths":{"/api/v1/accounts/{accountId}/name":{"patch":{"summary":"Update account name","tags":["accounts"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":3,"maxLength":100}},"required":["name"]}}},"required":true},"parameters":[{"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"in":"path","name":"accountId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"baseCurrency":{"type":"string"}},"required":["id","name","baseCurrency"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["undefined","unauthorized","unprocessable_entity","not_found","already_exists","bad_request","conflict","forbidden","internal_server_error","validation_error","missing_permissions","unexpected_error","limit_reached","not_implemented","account_not_found","auth_invalid_api_key","auth_invalid_token","auth_missing_api_key","auth_missing_authorization","auth_missing_employee_header","auth_invalid_employee_header","auth_missing_idempotency_key","custom_asset_not_found","custom_asset_referenced_by_operations","custom_asset_symbol_already_active","custom_asset_symbol_conflict_builtin","custom_asset_symbol_previously_deleted","asset_unknown_symbol","asset_unsupported","dfns_multiple_assets_found","dfns_unsupported_asset","dfns_unsupported_network","dfns_webhook_signature_invalid","dfns_operational_wallet_already_exists","dfns_operational_wallet_not_found","external_contact_has_accounts","external_contact_not_found","hercle_api_error","hercle_balance_not_found","hercle_deposit_account_details_invalid","hercle_deposit_account_details_not_found","hercle_deposit_address_not_found","hercle_inbound_transaction_not_found","hercle_not_initialized","hercle_pair_not_found","hercle_payee_address_not_found","hercle_payee_not_found","hercle_transaction_already_matched","hercle_transfer_not_found","idempotency_missing_key","idempotency_key_too_long","idempotency_key_in_progress","idempotency_hash_mismatch","hpp_invalid_action","hpp_no_available_virtual_iban","hpp_payment_request_locked","hpp_sender_verification_incomplete","identity_not_found","identity_deactivated","identity_missing_payment_instruction","identity_provider_id_not_found","identity_account_not_found","identity_account_deactivated","identity_account_cannot_activate_deactivated_identity","identity_account_cannot_deactivate_non_external","identity_account_creation_failed","identity_account_missing_payment_instruction","identity_account_invalid_wallet_address","identity_account_missing_payment_identifier","invoice_not_found","invoice_upload_not_found","invoice_upload_access_denied","invoice_file_too_large","invoice_file_type_not_allowed","kyt_already_approved","kyt_invalid_transaction_type","kyt_manual_decision_already_made","kyt_transaction_not_found","kyt_unsupported_workflow_type","ledger_lock_exists","ledger_lock_held_by_another","ledger_insufficient_fund","ledger_address_invalid","ledger_asset_not_found","ledger_balance_locked","ledger_invalid_asset_format","ledger_not_implemented","ledger_transaction_conflict","ledger_transaction_validation_error","ledger_unsupported_payment_system","mail_step_up_verification_failed","mail_step_up_operation_not_found","manual_operation_not_found","manual_operation_duplicate_pi_key","manual_operation_insufficient_funds","manual_operation_invalid_pi_type","manual_operation_missing_own_identity","manual_operation_organization_link_inactive","manual_operation_pi_missing_account","manual_operation_pi_missing_wallet_provider","manual_operation_pi_not_found","manual_operation_posting_validation_error","manual_operation_unknown_asset","manual_operation_invalid_status_transition","manual_operation_invalid_transacting_entity","manual_operation_pi_missing_identity_account","manual_operation_pi_missing_identifier","manual_operation_amount_not_resolved","manual_operation_organization_link_invalid","manual_operation_self_transfer_forbidden","manual_operation_asset_mismatch","manual_operation_amount_mismatch","mep_missing_rail_id","mep_unsupported_crypto","onboarding_not_found","organization_not_found","organization_missing_own_identity","organization_missing_own_identity_email","billing_config_not_found","billing_invalid_asset","billing_invalid_spread_same_currency","organization_link_not_found","organization_link_already_exists","organization_link_already_deactivated","organization_link_self_link_forbidden","payment_instruction_not_found","payment_instruction_account_mismatch","payment_instruction_asset_mismatch","payment_instruction_conflict","payment_instruction_duplicate_identifier","payment_instruction_missing_wallet","payment_instruction_not_fiat","payment_request_not_found","payment_request_already_completed","payment_request_already_has_invoice","payment_request_contact_deactivated","payment_request_contact_not_verified","payment_request_escrow_release_condition_required","payment_request_has_pending_transactions","payment_request_identity_not_external","payment_request_invalid_status_for_completion","payment_request_invoice_not_uploaded","payment_request_no_matching_billing_instruments","payment_request_release_condition_not_allowed","payment_request_amount_exceeds_limit","payment_request_transaction_amount_mismatch","payment_request_transaction_not_found","payout_not_found","payout_amounts_empty","payout_deactivated_contact","payout_deactivated_identity_account","payout_destination_pi_not_found","payout_fx_quote_not_found","payout_invalid_destination_asset","payout_invalid_source_asset","payout_payment_not_confirmed","payout_source_pi_not_found","payout_transaction_not_found","payout_validation_error","unsupported_payout_option","disabled_payout_option","payment_not_confirmed","quote_fx_calculation_error","quote_invalid_source_asset","quote_no_matching_billing_instruments","reconciliation_cancel_failed","reconciliation_result_not_found","reconciliation_run_already_active","reconciliation_run_already_terminal","reconciliation_run_not_found","reconciliation_unknown_rail_type","redis_lock_creation_failed","slack_api_error","sumsub_api_error","sumsub_applicant_already_exists","sumsub_invalid_digest","sumsub_missing_identity_provider_id","sumsub_payment_method_already_exists","sumsub_transaction_already_exists","sumsub_unsupported_chain","sumsub_unsupported_currency","sumsub_unsupported_payment_method","sumsub_validation_error","token_invalid","token_not_found","token_missing_permissions","topup_amount_verification_failed","topup_fee_processing_failed","topup_transaction_not_found","transaction_not_found","user_not_found","user_not_in_organization","user_role_not_found","user_cannot_delete_self","user_cannot_modify_admin","user_force_logout_failed","user_insufficient_permissions","user_invitation_config_error","user_invitation_conflict","user_invitation_failed","user_mfa_enrollment_failed","user_password_reset_failed","virtual_account_not_found","wallet_adapter_not_found","wallet_balance_insufficient","wallet_fee_sponsor_not_found","wallet_not_on_dfns","webhook_not_found","webhook_limit_reached","unsupported_webhook_type","workflow_invalid_type","workflow_signal_error","yellow_card_api_error","yellow_card_chunk_limit_exceeded","yellow_card_settlement_timeout","yellow_card_settlement_verification_failed","yellow_card_webhook_signature_invalid","courier_socket_not_initialized","dynamic_config_not_exists","unsupported_option_provided","unsupported_identifier_provided","required_identifier_missing"]},"message":{"type":"string"},"details":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"requestId":{"type":"string"},"timestamp":{"type":"string"},"issues":{"type":"object","additionalProperties":{}}},"required":["url","method","requestId","timestamp"],"additionalProperties":false}},"required":["code","message","details"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}}}}
```