# Create New Credit
Initial Fee Credit credits a specified account and deducts an equal amount from a contra account, without involving any settlement institutions. Use this API to credit funds to a specified account (such as GIFTING).
Related Event Notifications:
Please refer to the Event Push API documentation: [Credit Events](/apis/docs/reference/fd-events/fee-credit-events#credit-events)
# OpenAPI definition
```json
{
"info": {
"title": "Webull Open API Reference",
"description": "application.yml\\ncom\\ni18n\\nMETA-INF\\nstatic\\n\\r\\n",
"contact": {
"name": "",
"url": "",
"email": ""
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://broker-api.sandbox.webull.com"
}
],
"path": "/broker/credits/create",
"method": "post",
"tags": [
"Fees and Credits"
],
"description": "Initial Fee Credit credits a specified account and deducts an equal amount from a contra account, without involving any settlement institutions. Use this API to credit funds to a specified account (such as GIFTING).
Related Event Notifications:
Please refer to the Event Push API documentation: [Credit Events](/apis/docs/reference/fd-events/fee-credit-events#credit-events)",
"operationId": "brokerFundingCreditCreate",
"parameters": [
{
"name": "x-app-key",
"in": "header",
"description": "A unique identifier issued to a developer for accessing an application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-app-secret",
"in": "header",
"description": "A unique key issued to developers to access the application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-timestamp",
"in": "header",
"description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-signature-version",
"in": "header",
"description": "Signature algorithm version, default is 1.0.",
"required": true,
"schema": {
"type": "string",
"default": "1.0"
},
"examples": {
"1.0": {
"value": "1.0"
}
}
},
{
"name": "x-signature-algorithm",
"in": "header",
"description": "Signature algorithm, default is HMAC-SHA1.",
"required": true,
"schema": {
"type": "string",
"default": "HMAC-SHA1"
},
"examples": {
"HMAC-SHA1": {
"value": "HMAC-SHA1"
}
}
},
{
"name": "x-signature-nonce",
"in": "header",
"description": "Signature unique random number.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-version",
"in": "header",
"description": "API interface version. Supported values: `v2`, `v3`.",
"required": true,
"schema": {
"type": "string",
"default": "v3"
},
"examples": {
"v3": {
"value": "v3"
}
}
},
{
"name": "x-signature",
"in": "header",
"description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"account",
"amount",
"client_request_id",
"contra_account",
"currency",
"type"
],
"type": "object",
"properties": {
"client_request_id": {
"type": "string",
"description": "Client Request ID, unique for each request.
Maximum length is 32 characters.
Allowed characters: letters (A–Z, a–z), digits (0–9), hyphen (-), underscore (_).",
"example": "89JGKD4LKIVI5UU6L3KHNU10IA"
},
"account": {
"type": "string",
"description": "Account id.",
"example": "93IUJ28O9VO2KBGHDHR4H9"
},
"contra_account": {
"type": "string",
"description": "Firm Account",
"example": "41IO9QG4M5O65B0EA4LSJ4UJ99"
},
"type": {
"type": "string",
"description": "Credit Type",
"example": "GIFTING",
"enum": [
"GIFTING"
]
},
"amount": {
"type": "string",
"description": "Amount.",
"example": "100"
},
"currency": {
"type": "string",
"description": "Currency",
"example": "USD",
"enum": [
"USD"
]
}
},
"title": "CreateCreditParam"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"required": [
"account",
"amount",
"client_request_id",
"contra_account",
"create_time",
"credit_id",
"currency",
"status",
"type",
"update_time"
],
"type": "object",
"properties": {
"client_request_id": {
"type": "string",
"description": "Client Request ID, unique for each request.
Maximum length is 32 characters.
Allowed characters: letters (A–Z, a–z), digits (0–9), hyphen (-), underscore (_).",
"example": "89JGKD4LKIVI5UU6L3KHNU10IA"
},
"account": {
"type": "string",
"description": "Account id.",
"example": "93IUJ28O9VO2KBGHDHR4H9"
},
"contra_account": {
"type": "string",
"description": "Firm Account",
"example": "41IO9QG4M5O65B0EA4LSJ4UJ99"
},
"type": {
"type": "string",
"description": "Credit Type",
"example": "GIFTING",
"enum": [
"GIFTING"
]
},
"credit_id": {
"type": "string",
"description": "Request id generated by the system.",
"example": "89JGKD4LKIVI5UU6L3KHNU10IA"
},
"amount": {
"type": "string",
"description": "Amount.",
"example": "100"
},
"currency": {
"type": "string",
"description": "Currency",
"example": "USD",
"enum": [
"USD"
]
},
"status": {
"type": "string",
"description": "Request status",
"example": "SUBMITTED",
"enum": [
"SUBMITTED",
"CANCELED",
"REJECTED",
"FAILED",
"COMPLETED"
]
},
"reason": {
"type": "string",
"description": "Reason. If the terminal state is not “COMPLETED”, return the reason.",
"example": "Failed."
},
"create_time": {
"type": "string",
"description": "UTC time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example": "2025-01-05T22:59:59.012Z"
},
"update_time": {
"type": "string",
"description": "UTC time, format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example": "2025-01-05T22:59:59.012Z"
}
},
"title": "CreditResult"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Insufficient permission"
}
}
}
}
}
},
"417": {
"description": "A business logic error triggered when the request cannot be processed due to domain-specific constraints.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "INVALID_PARAMETER"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Parameter error, phone"
}
}
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "SYSTEM_ERROR"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"jsonRequestBodyExample": {
"client_request_id": "89JGKD4LKIVI5UU6L3KHNU10IA",
"account": "93IUJ28O9VO2KBGHDHR4H9",
"contra_account": "41IO9QG4M5O65B0EA4LSJ4UJ99",
"type": "GIFTING",
"amount": "100",
"currency": "USD"
},
"postman": {
"name": "Create New Credit",
"description": {
"content": "Initial Fee Credit credits a specified account and deducts an equal amount from a contra account, without involving any settlement institutions. Use this API to credit funds to a specified account (such as GIFTING).
Related Event Notifications:
Please refer to the Event Push API documentation: [Credit Events](/apis/docs/reference/fd-events/fee-credit-events#credit-events)",
"type": "text/plain"
},
"url": {
"path": [
"broker",
"credits",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) A unique identifier issued to a developer for accessing an application's API.",
"type": "text/plain"
},
"key": "x-app-key",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A unique key issued to developers to access the application's API.",
"type": "text/plain"
},
"key": "x-app-secret",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"type": "text/plain"
},
"key": "x-timestamp",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm version, default is 1.0.",
"type": "text/plain"
},
"key": "x-signature-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm, default is HMAC-SHA1.",
"type": "text/plain"
},
"key": "x-signature-algorithm",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature unique random number.",
"type": "text/plain"
},
"key": "x-signature-nonce",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) API interface version. Supported values: `v2`, `v3`.",
"type": "text/plain"
},
"key": "x-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"type": "text/plain"
},
"key": "x-signature",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
}
}
}
```