---
agentTools:
  projectIndex: https://developers.commerce.busha.co/llms.txt
---

# Create a charge for payment link

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Commerce",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.commerce.busha.co"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/payment_links/{id}/charge": {
      "post": {
        "summary": "Create a charge for payment link",
        "description": "",
        "operationId": "create-a-charge-for-checkout",
        "parameters": [
          {
            "name": "X-BC-API-KEY",
            "in": "header",
            "description": "Your business secret key",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "id(uuid) of the payment link",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "local_amount": {
                    "type": "string",
                    "description": "amount in local currency (float64) <br/> <b>N.B:</b> field is not required for a fixed price payment link charge."
                  },
                  "local_currency": {
                    "type": "string",
                    "description": "local currency of business <br/> <b>N.B:</b> field is not required for a fixed price payment link charge."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"message\": \"Charge created successfully\",\n    \"data\": {\n        \"business_name\": \"Astro\",\n        \"id\": \"756a9391-951f-4722-905c-f656144e9a5c\",\n        \"business_id\": \"3f2eb2df-34ca-4854-b05f-212a95d3fb50\",\n        \"reference\": \"RCF6PRO8AW\",\n        \"hosted_url\": \"https://commerce.busha.co/payment_links/b0548cca-2ddb-4044-9e47-2524e8db82e5\",\n        \"deeplink\": \"https:/busha.page.link/busha_pay/charge/756a9391-951f-4722-905c-f656144e9a5c\",\n        \"price_fixed\": false,\n        \"callback_url\": \"https://commerce.busha.co/payment_links/b0548cca-2ddb-4044-9e47-2524e8db82e5/response\",\n        \"local_currency\": \"NGN\",\n        \"meta\": {},\n        \"expires_at\": \"2023-04-03T15:26:38.108053235Z\",\n        \"timeline\": [\n            {\n                \"status\": \"NEW\",\n                \"created_at\": \"2023-04-03T14:26:38.108053235Z\"\n            }\n        ],\n        \"supported_assets\": [\n            {\n                \"currency_id\": \"BTC\",\n                \"chains\": [],\n                \"name\": \"Bitcoin\"\n            },\n            {\n                \"currency_id\": \"ETH\",\n                \"chains\": [],\n                \"name\": \"Ethereum\"\n            },\n            {\n                \"currency_id\": \"USDT\",\n                \"chains\": [\n                    \"ETH\",\n                    \"TRX\",\n                    \"BSC\"\n                ],\n                \"name\": \"USD Tether\"\n            }\n        ],\n        \"payment_threshold\": {\n            \"overpayment_absolute_threshold\": \"0\",\n            \"overpayment_relative_threshold\": \"0\",\n            \"underpayment_absolute_threshold\": \"0\",\n            \"underpayment_relative_threshold\": \"0\"\n        },\n        \"payments\": [],\n        \"pricing\": [\n            {\n                \"currency_id\": \"NGN\",\n                \"amount\": \"50000\",\n                \"rate\": \"1\",\n                \"is_local\": true\n            },\n            {\n                \"currency_id\": \"BTC\",\n                \"amount\": \"0.00236366\",\n                \"rate\": \"21153624\",\n                \"is_local\": false\n            },\n            {\n                \"currency_id\": \"ETH\",\n                \"amount\": \"0.03677642\",\n                \"rate\": \"1359566.6\",\n                \"is_local\": false\n            },\n            {\n                \"currency_id\": \"USDT\",\n                \"amount\": \"66.94964\",\n                \"rate\": \"746.83\",\n                \"is_local\": false\n            }\n        ],\n        \"addresses\": [\n            {\n                \"currency_id\": \"BTC\",\n                \"chain\": \"BTC\",\n                \"address\": \"2NEWBfwhSQJdSFYf8iGDnNShA8QQ191UYUt\",\n                \"label\": \"\",\n                \"memo\": \"\"\n            },\n            {\n                \"currency_id\": \"ETH\",\n                \"chain\": \"ETH\",\n                \"address\": \"0x8ECb5B8d787002B3C840F5b964dFA4Cd7F8c206b\",\n                \"label\": \"\",\n                \"memo\": \"\"\n            },\n            {\n                \"currency_id\": \"USDT\",\n                \"chain\": \"ETH\",\n                \"address\": \"0xdE47248620bf44B52384293BFDB5D993d3F9f2e5\",\n                \"label\": \"\",\n                \"memo\": \"\"\n            },\n            {\n                \"currency_id\": \"USDT\",\n                \"chain\": \"TRX\",\n                \"address\": \"TAgdQ7L9FrfrYDJAPQ5i6iESyT8hB4rdnu\",\n                \"label\": \"\",\n                \"memo\": \"\"\n            },\n            {\n                \"currency_id\": \"USDT\",\n                \"chain\": \"BSC\",\n                \"address\": \"0xE9484f86be90388eCe994518FfBb7f5FC472F51d\",\n                \"label\": \"\",\n                \"memo\": \"\"\n            }\n        ],\n        \"local_amount\": \"50000\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Charge created successfully"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "business_name": {
                          "type": "string",
                          "example": "Astro"
                        },
                        "id": {
                          "type": "string",
                          "example": "756a9391-951f-4722-905c-f656144e9a5c"
                        },
                        "business_id": {
                          "type": "string",
                          "example": "3f2eb2df-34ca-4854-b05f-212a95d3fb50"
                        },
                        "reference": {
                          "type": "string",
                          "example": "RCF6PRO8AW"
                        },
                        "hosted_url": {
                          "type": "string",
                          "example": "https://commerce.busha.co/payment_links/b0548cca-2ddb-4044-9e47-2524e8db82e5"
                        },
                        "deeplink": {
                          "type": "string",
                          "example": "https:/busha.page.link/busha_pay/charge/756a9391-951f-4722-905c-f656144e9a5c"
                        },
                        "price_fixed": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "callback_url": {
                          "type": "string",
                          "example": "https://commerce.busha.co/payment_links/b0548cca-2ddb-4044-9e47-2524e8db82e5/response"
                        },
                        "local_currency": {
                          "type": "string",
                          "example": "NGN"
                        },
                        "meta": {
                          "type": "object",
                          "properties": {}
                        },
                        "expires_at": {
                          "type": "string",
                          "example": "2023-04-03T15:26:38.108053235Z"
                        },
                        "timeline": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "status": {
                                "type": "string",
                                "example": "NEW"
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2023-04-03T14:26:38.108053235Z"
                              }
                            }
                          }
                        },
                        "supported_assets": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "currency_id": {
                                "type": "string",
                                "example": "BTC"
                              },
                              "chains": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {}
                                }
                              },
                              "name": {
                                "type": "string",
                                "example": "Bitcoin"
                              }
                            }
                          }
                        },
                        "payment_threshold": {
                          "type": "object",
                          "properties": {
                            "overpayment_absolute_threshold": {
                              "type": "string",
                              "example": "0"
                            },
                            "overpayment_relative_threshold": {
                              "type": "string",
                              "example": "0"
                            },
                            "underpayment_absolute_threshold": {
                              "type": "string",
                              "example": "0"
                            },
                            "underpayment_relative_threshold": {
                              "type": "string",
                              "example": "0"
                            }
                          }
                        },
                        "payments": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {}
                          }
                        },
                        "pricing": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "currency_id": {
                                "type": "string",
                                "example": "NGN"
                              },
                              "amount": {
                                "type": "string",
                                "example": "50000"
                              },
                              "rate": {
                                "type": "string",
                                "example": "1"
                              },
                              "is_local": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              }
                            }
                          }
                        },
                        "addresses": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "currency_id": {
                                "type": "string",
                                "example": "BTC"
                              },
                              "chain": {
                                "type": "string",
                                "example": "BTC"
                              },
                              "address": {
                                "type": "string",
                                "example": "2NEWBfwhSQJdSFYf8iGDnNShA8QQ191UYUt"
                              },
                              "label": {
                                "type": "string",
                                "example": ""
                              },
                              "memo": {
                                "type": "string",
                                "example": ""
                              }
                            }
                          }
                        },
                        "local_amount": {
                          "type": "string",
                          "example": "50000"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"error\": {\n        \"name\": \"bad_request\",\n        \"message\": \"amount or currency not required for a fixed-price checkout charge\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string",
                          "example": "bad_request"
                        },
                        "message": {
                          "type": "string",
                          "example": "amount or currency not required for a fixed-price checkout charge"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "63f94c2f2017a0005783edff:63fde8bdf01e530065f4dffd"
}
```