Skip to main content
POST
/
v1
/
payments
Create a payment request
curl --request POST \
  --url https://api.sandbox.busha.so/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_info": {
    "email": "jsmith@example.com",
    "phone_number": "+234 8012345678"
  },
  "dry_run": true,
  "quote_amount": "100",
  "quote_currency": "NGN",
  "source_amount": "100",
  "source_currency": "BTC",
  "target_amount": "100",
  "target_currency": "BTC",
  "pay_in": {
    "type": "address",
    "network": "BTC",
    "phone": "+234 8012345678"
  },
  "reference": "busha-123"
}'
{
  "status": "success",
  "message": "message for success",
  "data": {
    "id": "bus_123456789",
    "source_amount": "100",
    "source_currency": "BTC",
    "target_amount": "100",
    "target_currency": "BTC",
    "rate": {
      "product": "BTCUSDT",
      "source_currency": "BTC",
      "target_currency": "BTC",
      "rate": "100",
      "side": "sell",
      "type": "FIXED"
    },
    "fees": [
      {
        "name": "processing_fee",
        "amount": {
          "amount": "100",
          "currency": "BTC"
        },
        "converted_amount": {
          "amount": "100",
          "currency": "BTC"
        },
        "type": "FIXED"
      }
    ],
    "pay_in": {
      "type": "address",
      "recipient_id": "64ae8c26ea1033204c805a8a",
      "address": "tb1qj4263506wyu8khrz2dwce0agk8lhyjgy269rxr",
      "network": "BTC",
      "memo": "address memo",
      "profile_id": "profile-id-1234",
      "recipient_details": {
        "account_name": "<string>",
        "bank_name": "<string>",
        "account_number": "<string>",
        "country_code": "NG",
        "provider": "<string>",
        "currency": "<string>",
        "phone_number": "<string>",
        "name": "<string>",
        "email": "sbsbs@busha.co",
        "bank_code": "100020"
      },
      "blockchain_hash": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
      "blockchain_url": "https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
      "session_id": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
      "expires_at": "2023-10-15T12:15:30Z"
    },
    "reference": "<string>",
    "status": "pending",
    "additional_info": {
      "email": "jsmith@example.com",
      "phone_number": "+234 8012345678"
    },
    "merchant_info": {
      "name": "busha",
      "email": "busha@me.com"
    },
    "timeline": {
      "total_steps": 123,
      "current_step": 123,
      "transfer_status": "<string>",
      "events": [
        {
          "step": 1,
          "done": true,
          "status": "pending",
          "title": "Transfer started",
          "description": "Transfer started",
          "timestamp": "2023-10-15T12:15:30Z"
        }
      ]
    },
    "created_at": "2023-10-15T12:15:30Z",
    "updated_at": "2023-10-15T12:15:30Z",
    "expires_at": "2023-10-15T12:15:30Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer Authentication

Headers

​
X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

​
X-BU-PUBLIC-KEY
string
Example:

"pub_uibaidu930ani"

Body

application/json
​
additional_info
object
required
​
source_currency
string<string>
required

A valid currency

Required string length: 1 - 10
Example:

"BTC"

​
target_currency
string<string>
required

A valid currency

Required string length: 1 - 10
Example:

"BTC"

​
dry_run
boolean

if true, will not create a payment transfer

​
quote_amount
string

decimal value

Example:

"100"

​
quote_currency
string<string>

This optional field specifies the fiat currency to display amounts in, which is converted from the source amount A valid currency

Required string length: 1 - 10
Example:

"BTC"

​
source_amount
string

decimal value

Example:

"100"

​
target_amount
string

decimal value

Example:

"100"

​
pay_in
object
​
reference
string

reference for the payment request

Example:

"busha-123"

Response

Successful response

General response Values

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
message
string
required
Example:

"message for success"

​
data
object
required