Provision a new business currency

Request

Creates a new currency record for the business on the upstream service. The currency is required before any wallet can be created in that currency.

Security

oauth2ClientCredentials(Required scopes: accounts:write)

org_wallet_refstring

Organization wallet reference, defaults to "1" if not provided

business_idstringrequired

Business identifier for the request

Bodyapplication/jsonrequired

currencystringrequired

ISO 4217 currency code (uppercase, 3 letters)

Example:"USD"

curl -i -X POST \
  https://developer.boyahq.com/_mock/v2/openapi/accounts/create-new-currency \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string' \
  -d '{
    "currency": "USD"
  }'

Responses

Currency provisioned successfully

Bodyapplication/json

statusnumberrequired

HTTP status code

Example:200

dataobjectrequired

Response data

messagestring

Optional response message

Example:"Operation completed successfully"

timestampstringrequired

Response timestamp in ISO format

Example:"2024-01-01T00:00:00.000Z"

pathstring

Request path (mainly for error responses)

Example:"/api/v1/accounts"

Response

{
  "status": 200,
  "data": {},
  "message": "Operation completed successfully",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "path": "/api/v1/accounts"
}