Cedar Partners API
  1. Receiver Accounts
Cedar Partners API
  • Introduction
  • Getting Started
    • Data Model
    • Transaction Lifecycle
    • Authentication
    • API Environments
    • Webhooks Configuration
  • Development Tools
    • API Debugging
    • Error Codes
    • File URLs
  • API Documentation
    • Information
      • Get Countries
      • Get Currencies
    • Merchants
      • Create Merchant
      • Update Merchant
      • Get Merchant by ID
      • Get Merchants with Pagination
    • Onboarding
      • Onboarding Lifecycle
      • Get Legal Agreements
      • Accept Legal Agreements
      • Submit Merchant Onboarding
    • Receiver Accounts
      • Create Receiver Account
        POST
      • Update Receiver Account
        PUT
      • Get Receiver Account by ID
        GET
      • Get Receiver Accounts with Pagination
        GET
    • Transactions
      • Payout (Crypto-to-Fiat)
        • Calculate FX Rate
        • Create Payout Transaction
        • Get Payout Transaction by ID
        • Get Payout Transactions with Pagination
        • Approve Payout Transaction Quote
        • Approve Payout Transaction Deposit
        • Cancel Payout Transaction
      • End to End (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create End to End Transaction
        • Get End to End Transaction by ID
        • Get End to End Transactions with Pagination
        • Approve End to End Transaction Quote
        • Approve End to End Transaction Deposit
        • Cancel End to End Transaction
      • Collections (Fiat-to-Fiat)
        • Calculate FX Rate
        • Create Collections Transaction
        • Get Collections Transaction by ID
        • Get Collections Transactions with Pagination
        • Approve Collections Transaction Quote
        • Approve Collections Transaction Deposit
        • Cancel Collections Transaction
      • Get Payout Confirmation by Transaction ID
        GET
    • Utilities
      • Upload File
  1. Receiver Accounts

Update Receiver Account

Live Partners API
https://partners-api.service.cedar.money/bpapi
Live Partners API
https://partners-api.service.cedar.money/bpapi
PUT
https://partners-api.service.cedar.money/bpapi
/v1/businessExternalAccount/{id}
Updates the details of a specific receiver account.

Description#

Use this endpoint to update one or more fields of an existing receiver account.

Sandbox-Only Behavior: Simulate accountStatus Updates#

In sandbox mode only, you can simulate changes to the accountStatus of a receiver account by passing a special value in the accountNumber field.

How it Works#

If the value of the accountNumber field ends with a pipe character (|) followed by a valid accountStatus, the account’s status will be updated directly to that value and a webhook event will be triggered.

Example#

To update the account’s status to FROZEN:
{
  "accountNumber": "987654321|FROZEN"
}
This sets the accountStatus to FROZEN and emits a corresponding webhook notification.

Supported accountStatus Values#

CodeDisplay NameDescription
PENDINGPendingWaiting for approval or activation
ACTIVEActiveCurrently in use and operational
FROZENFrozenTemporarily restricted from transactions
CLOSEDClosedAccount is permanently closed
⚠️ This behavior is only available in sandbox environments for testing. In production, account status transitions are controlled by the platform’s internal processes and cannot be set manually.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "accountNumber": "9876543210",
    "accountHolderName": "Alice Johnson",
    "bankName": "Global Trust Bank",
    "swiftCode": "GTBABC45XYZ",
    "iban": "GB29NWBK60161331926819",
    "routingNumber": "021000021",
    "countryIso": "US",
    "state": "NY",
    "city": "New York",
    "address": "Main Street",
    "streetNumber": "123",
    "zipCode": "10001"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://partners-api.service.cedar.money/bpapi/v1/businessExternalAccount/1' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountNumber": "9876543210",
    "accountHolderName": "Alice Johnson",
    "bankName": "Global Trust Bank",
    "swiftCode": "GTBABC45XYZ",
    "iban": "GB29NWBK60161331926819",
    "routingNumber": "021000021",
    "countryIso": "US",
    "state": "NY",
    "city": "New York",
    "address": "Main Street",
    "streetNumber": "123",
    "zipCode": "10001"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "id": 1,
    "creationTime": 1741013991817,
    "lastUpdateTime": 1741013991817,
    "accountNumber": "9876543210",
    "accountHolderName": "Alice Johnson",
    "bankName": "Global Trust Bank",
    "swiftCode": "GTBABC45XXX",
    "iban": "GB29NWBK60161331926819",
    "routingNumber": "021000021",
    "countryIso": "US",
    "address": "Main Street",
    "streetNumber": "123",
    "city": "New York",
    "state": "NY",
    "zipCode": "10001",
    "businessId": 1,
    "currencySymbol": "USD",
    "accountStatus": "PENDING"
}
🟠400Error
Modified at 2025-06-01 08:30:39
Previous
Create Receiver Account
Next
Get Receiver Account by ID
Built with