v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Organization

Get Organization

The Get Organization endpoint allows you to retrieve your organization's current settings and details. This includes key information such as the organization's name, logo_url, and webhook_url. Use this endpoint to verify that your organization's configuration in BoomFi is accurate and up to date.

get/v1/orgs

Response

idstring

The unique identifier for BoomFi

namestring

The name of the BoomFi service

owner_user_idstring

The user ID of the owner

webhook_urlstring uri

The URL for webhook notifications

logo_urlstring uri

The URL for the logo of BoomFi

offramp_fee_pctnumber

The offramp fee percentage

payment_fee_pctnumber

The payment fee percentage

swap_fee_pctnumber

The swap fee percentage

credits_usdnumber

The credits in USD

created_atstring date-time

The timestamp when BoomFi was created

updated_atstring date-time

The timestamp when BoomFi was last updated

Example response

{
  "id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
  "name": "BoomFi",
  "owner_user_id": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
  "webhook_url": "https://webhook.site/b09eec23-3f7a-4f0c-aec6-84c277c5eb78",
  "logo_url": "https://boomfi-test-addonsstack-ipj55n-merchantdatabucket-11rcw286tjikp.s3.eu-west-2.amazonaws.com/7403e69d-71c7-4ab4-8b19-7130ecd0bb3e/merchant-logos/57da50bd-857a-4658-8916-7f4a5f9ad9ad.png",
  "offramp_fee_pct": 1,
  "payment_fee_pct": 1,
  "swap_fee_pct": 1,
  "created_at": "2023-08-11T10:09:25.679Z",
  "updated_at": "2024-03-29T13:59:55.003Z",
  "properties": {
    "ramp": {
      "enabled": true
    },
    "spreedly": {
      "merchant_profile_id": "65oxw5ZZ2lE4siMz618v4HQqD2X",
      "sca_authentication_enabled": true,
      "sca_provider_id": "YN8LHxRK9ysWlKfdWZdDCtUM2TI",
      "sub_merchant_data": "eyJ0b2tlbiI6Ik5zVkUyV1E0eWZmUklBaDRSMENzalRXYU5naSIsIm5hbWUiOiJDcmV3IiwiZW52aXJvbm1lbnRfa2V5IjoiM0I1TkFGWTlBTTkyODlGWDZROTVOM1g4RFciLCJtZXJjaGFudF9kZWZpbmVkX3VpZCI6IjJUcG1ubWg2R0hKWHVtS04xb0J5MnU1NkltYSIsImFkZHJlc3MiOnsiYWRkcmVzczEiOiIiLCJjaXR5IjoiIiwic3RhdGUiOiIiLCJ6aXAiOiIiLCJjb3VudHJ5IjoiIn0sIm1ldGFkYXRhIjpudWxsLCJjcmVhdGVkX2F0IjoiMjAyNC0wMi0xNlQxNDo0OToyM1oiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMi0xNlQxNDo0OToyM1oifQ==",
      "sub_merchant_id": "NsVE2WQ4yffRIAh4R0CsjTWaNgi"
    }
  }
}