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
    • Utilities
      • Upload File
  1. Receiver Accounts

Create Receiver Account

Live Partners API
Live Partners API
POST
https://partners-api.service.cedar.money/bpapi/v1/businessExternalAccount/
Creates a receiver account for a merchant.

Request

Header Params
x-api-key
string 
required
Example:
CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed
x-api-secret
string 
required
Example:
CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB
Body Params application/json
businessId
integer 
required
The account's owner merchant ID
currencySymbol
string 
required
The account's currency
accountNumber
string 
required
The bank account number
accountHolderName
string 
required
The bank account holder full name
bankName
string 
required
The account' bank name
swiftCode
string 
required
The bank account SWIFT code
iban
string 
optional
The bank account IBAN
routingNumber
string 
optional
The bank account ABA / Routing number
countryIso
string 
required
The bank's address country ISO2
state
string 
optional
The bank's address state ISO2
city
string 
required
The bank's address city
address
string 
required
The bank's street address
streetNumber
string 
required
The bank's address street number
zipCode
string 
required
The bank's address zip code
invoiceUrl
string 
required
URL to an example invoice for the bank account. Supported file formats: PDF (preferred), PNG, JPG
Example
{
  "businessId": 1,
  "currencySymbol": "USD",
  "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",
  "invoiceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
}

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 POST 'https://partners-api.service.cedar.money/bpapi/v1/businessExternalAccount/' \
--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 '{
    "businessId": 1,
    "currencySymbol": "USD",
    "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",
    "invoiceUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
}'

Responses

🟢200OK
application/json
Body
id
integer 
required
The receiver account's ID
creationTime
integer 
required
The entity creation time in UNIX timestamp
lastUpdateTime
integer 
required
The entity last update time in UNIX timestamp
businessId
integer 
required
The account's owner merchant ID
currencySymbol
string 
required
The account's currency
accountStatus
enum<string> 
required
The current verification status of the account
Allowed values:
PENDINGACTIVEFROZENCLOSED
accountNumber
string 
required
The bank account number
accountHolderName
string 
required
The bank account holder full name
bankName
string 
required
The account' bank name
swiftCode
string 
required
The bank account SWIFT code
iban
string 
optional
The bank account IBAN
routingNumber
string 
optional
The bank account ABA / Routing number
countryIso
string 
required
The bank's address country ISO2
state
string 
required
The bank's address state ISO2
city
string 
required
The bank's address city
address
string 
required
The bank's street address
streetNumber
string 
required
The bank's address street number
zipCode
string 
required
The bank's address zip code
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-03-04 12:57:19
Previous
Submit Merchant Onboarding
Next
Update Receiver Account
Built with