Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
payments
List payments
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://prod-payments-api.forebit.io/v1/businesses/{businessId}/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "endAmount": 123,
      "currency": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "AWAITING_PAYMENT",
      "description": "<string>",
      "customerEmail": "<string>",
      "paymentMethod": "<string>",
      "selectedPaymentMethod": "FOREBIT_CRYPTO",
      "forebitCryptoCharge": {
        "amount": 123,
        "coinName": "<string>",
        "exchangeRate": 123,
        "isUnderpaid": true,
        "address": "<string>",
        "network": "ETHEREUM"
      },
      "contractCharge": {
        "amount": 123,
        "coinName": "<string>",
        "exchangeRate": 123,
        "isUnderpaid": true,
        "address": "<string>"
      }
    }
  ],
  "message": "<string>",
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Pass your JWT token in the Authorization header as a Bearer token.

Path Parameters

businessId
integer<int64>
required

The target business ID.

Query Parameters

PageNumber
integer<int32>
PageSize
integer<int32>
fromTime
string<date-time>

Start of the date range filter.

toTime
string<date-time>

End of the date range filter.

statuses
enum<string>[]

Narrow results to these statuses.

Available options:
AWAITING_PAYMENT,
PENDING,
PROCESSING,
UNDERPAID,
COMPLETED,
FAILED,
CANCELLED,
EXPIRED
cryptoCoins
enum<string>[]

Narrow results to these coins.

Available options:
BITCOIN,
ETHEREUM,
LITECOIN,
BITCOIN_CASH,
ETH_USD_COIN,
ETH_TETHER,
MONERO,
BNB,
ETH_BUSD,
ETH_MATIC,
ETH_SHIBA_INU,
ETH_APE_COIN,
ETH_CRONOS,
ETH_DAI,
ETH_UNISWAP,
TRON,
TRX_TETHER,
TRX_USD_C,
UNKNOWN,
CONTRACT_ERC20_ETH,
CONTRACT_ERC20_USDT,
CONTRACT_ERC20_USDC,
CONTRACT_TRC20_TRX,
CONTRACT_TRC20_USDT,
CONTRACT_TRC20_USDC,
SOLANA,
SOL_TETHER,
SOL_USD_COIN,
TON
fromAmount
number<double>

Minimum amount threshold.

toAmount
number<double>

Maximum amount threshold.

searchString
string

Free-text match against description, name, note, or customer email.

onBehalfOfBusinessId
integer<int64>

Scope to a specific on-behalf-of business.

Response

Payments returned.

data
object[] | null
message
string | null
errors
string[] | null