Busha Developer Documentation

List payment requests

curl --request GET \
  --url https://api.sandbox.busha.so/v1/payments/requests \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "bus_123456789",
      "source_amount": "100",
      "source_currency": "BTC",
      "target_amount": "100",
      "target_currency": "BTC",
      "rate": {
        "product": "BTCUSDT",
        "rate_explained": "1 BTC = 1000 USDT",
        "source_currency": "BTC",
        "target_currency": "BTC",
        "rate": "100",
        "side": "sell",
        "type": "FIXED"
      },
      "fees": [
        {
          "name": "processing_fee",
          "amount": {
            "amount": "100",
            "currency": "BTC"
          },
          "type": "FIXED",
          "converted_amount": {
            "amount": "100",
            "currency": "BTC"
          }
        }
      ],
      "reference": "<string>",
      "status": "pending",
      "additional_info": {
        "email": "[email protected]",
        "phone_number": "+234 8012345678",
        "name": "John",
        "source": "web"
      },
      "merchant_info": {
        "name": "busha",
        "email": "[email protected]"
      },
      "created_at": "2023-10-15T12:15:30Z",
      "updated_at": "2023-10-15T12:15:30Z",
      "expires_at": "2023-10-15T12:15:30Z",
      "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>",
          "iban": "NG12345678901234567890",
          "currency": "<string>",
          "phone_number": "<string>",
          "name": "<string>",
          "email": "[email protected]",
          "bank_code": "100020"
        },
        "blockchain_hash": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "blockchain_url": "https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "session_id": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "from_address": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "expires_at": "2023-10-15T12:15:30Z"
      },
      "source": "<string>",
      "source_id": "<string>",
      "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"
          }
        ]
      }
    }
  ]
}

GET

payments

requests

List payment requests

curl --request GET \
  --url https://api.sandbox.busha.so/v1/payments/requests \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "message for success",
  "pagination": {
    "current_entries_size": 20,
    "next_cursor": "MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA=",
    "previous_cursor": "MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="
  },
  "data": [
    {
      "id": "bus_123456789",
      "source_amount": "100",
      "source_currency": "BTC",
      "target_amount": "100",
      "target_currency": "BTC",
      "rate": {
        "product": "BTCUSDT",
        "rate_explained": "1 BTC = 1000 USDT",
        "source_currency": "BTC",
        "target_currency": "BTC",
        "rate": "100",
        "side": "sell",
        "type": "FIXED"
      },
      "fees": [
        {
          "name": "processing_fee",
          "amount": {
            "amount": "100",
            "currency": "BTC"
          },
          "type": "FIXED",
          "converted_amount": {
            "amount": "100",
            "currency": "BTC"
          }
        }
      ],
      "reference": "<string>",
      "status": "pending",
      "additional_info": {
        "email": "[email protected]",
        "phone_number": "+234 8012345678",
        "name": "John",
        "source": "web"
      },
      "merchant_info": {
        "name": "busha",
        "email": "[email protected]"
      },
      "created_at": "2023-10-15T12:15:30Z",
      "updated_at": "2023-10-15T12:15:30Z",
      "expires_at": "2023-10-15T12:15:30Z",
      "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>",
          "iban": "NG12345678901234567890",
          "currency": "<string>",
          "phone_number": "<string>",
          "name": "<string>",
          "email": "[email protected]",
          "bank_code": "100020"
        },
        "blockchain_hash": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "blockchain_url": "https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "session_id": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "from_address": "31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171",
        "expires_at": "2023-10-15T12:15:30Z"
      },
      "source": "<string>",
      "source_id": "<string>",
      "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"
          }
        ]
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer Authentication

Headers

X-BU-PROFILE-ID

string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

cursor

string<string>

The cursor

sort

enum<string>

The order to sort the results

Available options:

asc,

desc

Example:

"asc"

limit

integer

The number of items to return

Example:

10

Response

Successful response

General response Values

status

enum<string>

required

Available options:

success,

error

Example:

"success"

message

string

required

Example:

"message for success"

pagination

object

required

Show child attributes

pagination.current_entries_size

integer

required

Example:

20

pagination.next_cursor

string

Example:

"MjAyNC0xMC0xNVQxMTowNTo1My45NTkxNDErMDE6MDA="

pagination.previous_cursor

string

Example:

"MjAyNC0xMC0xNVQxMDowNTo1My45NTIxQjE3MDE6MDA="

data

object[]

required

List of payment requests

Show child attributes

data.id

string<nanoid>

required

A valid id

Example:

"bus_123456789"

data.source_amount

string

required

decimal value

Example:

"100"

data.source_currency

string<string>

required

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.target_amount

string

required

decimal value

Example:

"100"

data.target_currency

string<string>

required

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.rate

object

required

Show child attributes

data.rate.product

string

Example:

"BTCUSDT"

data.rate.rate_explained

string

Example:

"1 BTC = 1000 USDT"

data.rate.source_currency

string<string>

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.rate.target_currency

string<string>

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.rate.rate

string

decimal value

Example:

"100"

data.rate.side

enum<string>

Available options:

buy,

sell

Example:

"sell"

data.rate.type

enum<string>

Available options:

FIXED

Example:

"FIXED"

data.fees

object[]

required

Show child attributes

data.fees.name

string

required

Example:

"processing_fee"

data.fees.amount

object

required

Amount with currency

Show child attributes

data.fees.amount.amount

string

required

decimal value

Example:

"100"

data.fees.amount.currency

string<string>

required

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.fees.type

enum<string>

required

Available options:

FIXED,

PERCENTAGE,

TIERED

Example:

"FIXED"

data.fees.converted_amount

object

Amount with currency

Show child attributes

data.fees.converted_amount.amount

string

required

decimal value

Example:

"100"

data.fees.converted_amount.currency

string<string>

required

A valid currency

Required string length: 1 - 10

Example:

"BTC"

data.reference

string

required

data.status

enum<string>

required

Available options:

pending,

expired,

cancelled,

completed,

failed,

multiple_deposits,

under_payment,

over_payment

data.additional_info

object

required

Show child attributes

data.additional_info.email

string<email>

required

email address for the payment request

data.additional_info.phone_number

string<phone>

A valid phone number. format {{calling_code}} {{number}}

Example:

"+234 8012345678"

data.additional_info.name

string

A valid name

Example:

"John"

data.additional_info.source

string

The source of the payment request

Example:

"web"

data.merchant_info

object

required

Show child attributes

data.merchant_info.name

string

required

name of the business

Example:

"busha"

data.merchant_info.email

string<email>

email of the business

Example:

"[email protected]"

data.created_at

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.updated_at

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.expires_at

string<date-time>

required

Example:

"2023-10-15T12:15:30Z"

data.pay_in

object

Show child attributes

data.pay_in.type

enum<string>

required

Available options:

address,

bank_transfer,

mobile_money,

business_mobile_money,

balance

Example:

"address"

data.pay_in.recipient_id

string

This represents the recipient ID, used for mobile_money and bank_transfer types.

Example:

"64ae8c26ea1033204c805a8a"

data.pay_in.address

string

This could be the address, user email or username for type address.

Example:

"tb1qj4263506wyu8khrz2dwce0agk8lhyjgy269rxr"

data.pay_in.network

string

This specifies the blockchain network associated with the address receiving the payment, typically used with address type payouts.

Example:

"BTC"

data.pay_in.memo

string

This refers to the memo required for blockchain networks that mandate a memo for cryptocurrency transactions.

Example:

"address memo"

data.pay_in.profile_id

string

Example:

"profile-id-1234"

data.pay_in.recipient_details

object

Show child attributes

data.pay_in.recipient_details.account_name

string

data.pay_in.recipient_details.bank_name

string

data.pay_in.recipient_details.account_number

string

data.pay_in.recipient_details.country_code

string

Example:

"NG"

data.pay_in.recipient_details.provider

string

data.pay_in.recipient_details.iban

string

Example:

"NG12345678901234567890"

data.pay_in.recipient_details.currency

string

data.pay_in.recipient_details.phone_number

string

data.pay_in.recipient_details.name

string

data.pay_in.recipient_details.email

string

Example:

"[email protected]"

data.pay_in.recipient_details.bank_code

string

Example:

"100020"

data.pay_in.blockchain_hash

string

Example:

"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171"

data.pay_in.blockchain_url

string

Example:

"https://explorer.com/tx/31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171"

data.pay_in.session_id

string

Example:

"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171"

data.pay_in.from_address

string

Example:

"31b99c79e2fb7554d0a9421867a53a80e6810cdfd2b06826eec1b2a22974b171"

data.pay_in.expires_at

string<date-time>

Example:

"2023-10-15T12:15:30Z"

data.source

string

The source of the payment request

data.source_id

string

The source id of the payment request

data.timeline

object

Show child attributes

data.timeline.total_steps

integer

required

data.timeline.current_step

integer

required

data.timeline.transfer_status

string

required

data.timeline.events

object[]

required

Show child attributes

data.timeline.events.step

integer

required

Example:

1

data.timeline.events.done

boolean

required

Example:

true

data.timeline.events.status

enum<string>

required

Available options:

pending,

processing,

funds_converted,

funds_received,

outgoing_payment_sent,

funds_delivered,

failed,

completed

data.timeline.events.title

string

required

Example:

"Transfer started"

data.timeline.events.description

string

required

Waiting for payment

Example:

"Transfer started"

data.timeline.events.timestamp

string<date-time>

Example:

"2023-10-15T12:15:30Z"

Create a payment request for payment link Create a payment request

⌘I

API reference

Authorizations

Headers

Query Parameters

Response