Busha Developer Documentation

List payment requests

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.busha.so/v1/payments/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.busha.so/v1/payments/requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.busha.so/v1/payments/requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.busha.so/v1/payments/requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
      "requested_amount": "100",
      "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>",
      "additional_info": {
        "email": "jsmith@example.com",
        "phone_number": "+2348012345678",
        "name": "John",
        "source": "web"
      },
      "merchant_info": {
        "name": "busha",
        "email": "busha@me.com"
      },
      "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",
        "narration": "Payment for services",
        "payment_invoice_url": "https://example.com/invoice.pdf",
        "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": "sbsbs@busha.co",
          "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"
      },
      "two_step": {
        "type": "authenticator",
        "message": "Enter your 2FA code to continue",
        "resend_allowed": false
      },
      "merchant_reference": "<string>",
      "source": "<string>",
      "source_id": "<string>",
      "timeline": {
        "total_steps": 123,
        "current_step": 123,
        "transfer_status": "<string>",
        "events": [
          {
            "step": 1,
            "done": true,
            "title": "Transfer started",
            "description": "Transfer started",
            "timestamp": "2023-10-15T12:15:30Z"
          }
        ]
      },
      "quote_rate": {
        "product": "BTCUSDT",
        "rate_explained": "1 BTC = 1000 USDT",
        "source_currency": "BTC",
        "target_currency": "BTC",
        "rate": "100",
        "side": "sell",
        "type": "FIXED"
      }
    }
  ]
}

GET

payments

requests

List payment requests

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.busha.so/v1/payments/requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.busha.so/v1/payments/requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.busha.so/v1/payments/requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.busha.so/v1/payments/requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
      "requested_amount": "100",
      "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>",
      "additional_info": {
        "email": "jsmith@example.com",
        "phone_number": "+2348012345678",
        "name": "John",
        "source": "web"
      },
      "merchant_info": {
        "name": "busha",
        "email": "busha@me.com"
      },
      "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",
        "narration": "Payment for services",
        "payment_invoice_url": "https://example.com/invoice.pdf",
        "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": "sbsbs@busha.co",
          "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"
      },
      "two_step": {
        "type": "authenticator",
        "message": "Enter your 2FA code to continue",
        "resend_allowed": false
      },
      "merchant_reference": "<string>",
      "source": "<string>",
      "source_id": "<string>",
      "timeline": {
        "total_steps": 123,
        "current_step": 123,
        "transfer_status": "<string>",
        "events": [
          {
            "step": 1,
            "done": true,
            "title": "Transfer started",
            "description": "Transfer started",
            "timestamp": "2023-10-15T12:15:30Z"
          }
        ]
      },
      "quote_rate": {
        "product": "BTCUSDT",
        "rate_explained": "1 BTC = 1000 USDT",
        "source_currency": "BTC",
        "target_currency": "BTC",
        "rate": "100",
        "side": "sell",
        "type": "FIXED"
      }
    }
  ]
}

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

string[]

uuid and nano_id

string

Search query for payment requests

status

string

filter by status Payment Status

asset

string[]

filter by asset Payment assets

start_time

string<date>

filter by date Filter by date in ISO 8601 format

Example:

"2023-10-01"

end_time

string<date>

filter by date Filter by date in ISO 8601 format

Example:

"2023-10-01"

type

enum<string>

filter by type Payment Type

Available options:

donation,

checkout,

invoice

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

data

object[]

required

List of payment requests

Show child attributes

Activate a draft invoice Create a payment request