{
  "aid": "swaggerhub.bringin-a9e:bringin-ap-is-1.0.0",
  "name": "Bringin APIs",
  "type": "Index",
  "description": "This is Bringin APIs that you can use to make a Bitcoin on and off-ramp available for your European customers. We intend to provide a simple yet best crypto on and off-ramp solution with SEPA instant support at the best rates in the market.\n\n## Authentication\n\nWhile the APIs are available to the public to build, we provide an 'api-key' and 'api-secret' for each company to make secure API calls.\n\n### Request Headers\n\nAll API requests must be accompanied by the following headers:\n\n| Header Parameter | Description |\n| --- | --- |\n| api-key | Contact us at info@bringin.xyz to obtain API key. |\n| Authorization | A signature generated using the API Secret. Contact us at info@bringin.xyz to obtain the API secret. More information is below on generating a signature. |\n| Content-Type | application/json |\n\n> The sandbox and production environments mirror each other, except for the base URL and your API keys. Please contact us at info@bringin.xyz to elevate your application to production.\n\n### Calculating your request signature\n\nYou can calculate the value of the `Authorization` header above by creating a SHA256HMAC digest (MD5) of your request body, signed with your `API Secret`, in the following manner:\n\n1. Fetch the current UNIX timestamp\n2. Stringify the body of your request\n3. Calculate the hex encoded MD5 digest of your request body exactly as it will be sent\n4. Concatenate the UNIX timestamp with the request verb, path and the `requestContentHexString`\n5. Use your API Secret to create a SHA256 HMAC digest in hex\n6. Finally, create your authorization header as follows, using the verb 'HMAC ' concatenated with the timestamp and the `requestSignatureHexString`, separated by a `:`\n\n### Example Implementation\n\n```typescript\nimport crypto from 'crypto';\nconst hmac = crypto.createHmac('sha256', '');\nconst time = Date.now().toString();\nhmac.update(time);\nhmac.update('POST');\nhmac.update('/ping');\nconst contentHash = crypto.createHash('md5');\ncontentHash.update(JSON.stringify({\n    \"dummy\": 1,\n    \"data\": 2\n}));\nhmac.update(contentHash.digest('hex'));\nconsole.log(`HMAC ${time}:${hmac.digest('hex')}`);\n```\n\n## Webhooks\n\n### Order Status Webhook\n```\n{\n  orderId: string;\n  status: \"SUCCESSFUL\" | \"INITIATED\" | \"PROCESSING\" | \"FAILED\" | \"EXPIRED\";\n  userId: string;\n  sourceId: string;\n  label: string;\n  price: {\n    price: string;\n    currency: Currency;\n  };\n  sourceAmount: string;\n  destinationAmount: string;\n  destinationCurrency: Currency;\n  timestamp: string;\n}\n```\n\n### Verification Status Webhook\n```\n{\n    \"userId\": \"f5cbb00c-d36b-4b0d-b8ef-f412757603df\",\n    \"apikey\": \"MDU4MTJlNjdkYWU1NGJiZGE0ZjAxNzQ4YzM0NWJlYmE=\",\n    \"verificationStatus\": \"APPROVED\",\n    \"ref\": \"3d1bac50-bed6-4c80-ac91-092140226f7d\"\n}\n```\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.bringin-a9e/bringin-ap-is/1.0.0/apis.json",
  "tags": [
    "swaggerhub.bringin-a9e",
    "bringin-ap-is"
  ],
  "created": "2026-04-04",
  "modified": "2026-04-04",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.bringin-a9e:bringin-ap-is-1.0.0",
      "name": "Bringin APIs",
      "description": "This is Bringin APIs that you can use to make a Bitcoin on and off-ramp available for your European customers. We intend to provide a simple yet best crypto on and off-ramp solution with SEPA instant support at the best rates in the market.\n\n## Authentication\n\nWhile the APIs are available to the public to build, we provide an 'api-key' and 'api-secret' for each company to make secure API calls.\n\n### Request Headers\n\nAll API requests must be accompanied by the following headers:\n\n| Header Parameter | Description |\n| --- | --- |\n| api-key | Contact us at info@bringin.xyz to obtain API key. |\n| Authorization | A signature generated using the API Secret. Contact us at info@bringin.xyz to obtain the API secret. More information is below on generating a signature. |\n| Content-Type | application/json |\n\n> The sandbox and production environments mirror each other, except for the base URL and your API keys. Please contact us at info@bringin.xyz to elevate your application to production.\n\n### Calculating your request signature\n\nYou can calculate the value of the `Authorization` header above by creating a SHA256HMAC digest (MD5) of your request body, signed with your `API Secret`, in the following manner:\n\n1. Fetch the current UNIX timestamp\n2. Stringify the body of your request\n3. Calculate the hex encoded MD5 digest of your request body exactly as it will be sent\n4. Concatenate the UNIX timestamp with the request verb, path and the `requestContentHexString`\n5. Use your API Secret to create a SHA256 HMAC digest in hex\n6. Finally, create your authorization header as follows, using the verb 'HMAC ' concatenated with the timestamp and the `requestSignatureHexString`, separated by a `:`\n\n### Example Implementation\n\n```typescript\nimport crypto from 'crypto';\nconst hmac = crypto.createHmac('sha256', '');\nconst time = Date.now().toString();\nhmac.update(time);\nhmac.update('POST');\nhmac.update('/ping');\nconst contentHash = crypto.createHash('md5');\ncontentHash.update(JSON.stringify({\n    \"dummy\": 1,\n    \"data\": 2\n}));\nhmac.update(contentHash.digest('hex'));\nconsole.log(`HMAC ${time}:${hmac.digest('hex')}`);\n```\n\n## Webhooks\n\n### Order Status Webhook\n```\n{\n  orderId: string;\n  status: \"SUCCESSFUL\" | \"INITIATED\" | \"PROCESSING\" | \"FAILED\" | \"EXPIRED\";\n  userId: string;\n  sourceId: string;\n  label: string;\n  price: {\n    price: string;\n    currency: Currency;\n  };\n  sourceAmount: string;\n  destinationAmount: string;\n  destinationCurrency: Currency;\n  timestamp: string;\n}\n```\n\n### Verification Status Webhook\n```\n{\n    \"userId\": \"f5cbb00c-d36b-4b0d-b8ef-f412757603df\",\n    \"apikey\": \"MDU4MTJlNjdkYWU1NGJiZGE0ZjAxNzQ4YzM0NWJlYmE=\",\n    \"verificationStatus\": \"APPROVED\",\n    \"ref\": \"3d1bac50-bed6-4c80-ac91-092140226f7d\"\n}\n```\n",
      "image": "",
      "baseURL": "https://dev.bringin.xyz",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.bringin-a9e/bringin-ap-is/1.0.0",
      "version": "1.0.0",
      "tags": [
        "swaggerhub.bringin-a9e",
        "bringin-ap-is"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.bringin-a9e/bringin-ap-is/1.0.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.bringin-a9e/bringin-ap-is/1.0.0"
        }
      ],
      "contact": [
        {
          "FN": "info@bringin.xyz",
          "email": "info@bringin.xyz"
        }
      ]
    }
  ]
}