🧾Invoices

Create an invoice

Create a new invoice for payment

POSThttps://api.simplepay.ai/invoice

Authorization

Body

app_idstring (uuid)

Example: "deae9fe3-9f00-4c18-8b24-dbc86e142128"

typeenum

Example: "payment"

payment

client_idstring (uuid)

Example: "efbc65e8-7e94-4362-b9dd-454a6c44572e"

fromstring

Example: "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz"

networkenum

Example: "tron"

ethereumtronbscbitcoinlitecoin

cryptocurrencyenum

Example: "TRX"

ETHBNBBTCLTCTRXUSDT

currencyenum

Example: "USD"

USD

pricenumber

Example: 120

Response

Successful response

Body

idstring (uuid)

Example: "2177ef62-1644-42e7-b1ef-32082110b2fa"

parent_idnullable string

client_idstring (uuid)

Example: "efbc65e8-7e94-4362-b9dd-454a6c44572e"

fromstring

Example: "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz"

tostring

Example: "TQgRam4iNcSJAs9nd3uczxTd29YDouGScd"

amountstring

Example: "1005.648391800613432786"

pricestring

Example: "120.00"

typestring

Example: "payment"

statusstring

Example: "created"

tx_hashnullable string

tx_blocknullable string

created_atstring (date-time)

Example: "2024-08-05T09:51:42.762715997Z"

updated_atstring (date-time)

Example: "2024-08-05T09:51:42.762715997Z"

expire_atstring (date-time)

Example: "2024-08-05T10:16:42.762715997Z"

cryptocurrencyobject

networkobject

currencyobject

Request

const response = await fetch('https://api.simplepay.ai/invoice', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "2177ef62-1644-42e7-b1ef-32082110b2fa",
  "parent_id": null,
  "client_id": "efbc65e8-7e94-4362-b9dd-454a6c44572e",
  "from": "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz",
  "to": "TQgRam4iNcSJAs9nd3uczxTd29YDouGScd",
  "amount": "1005.648391800613432786",
  "price": "120.00",
  "type": "payment",
  "status": "created",
  "tx_hash": null,
  "tx_block": null,
  "created_at": "2024-08-05T09:51:42.762715997Z",
  "updated_at": "2024-08-05T09:51:42.762715997Z",
  "expire_at": "2024-08-05T10:16:42.762715997Z",
  "cryptocurrency": {
    "id": "65992ab6-09e9-460d-8f9a-c6cf1d5627f1",
    "symbol": "TRX",
    "decimals": 18,
    "stable": false
  },
  "network": {
    "id": "0a7a7f1f-56af-495f-b34d-1fc63e85f614",
    "symbol": "tron",
    "type": "TRX"
  },
  "currency": {
    "id": "5e091838-d7bb-4365-a395-84d82d1ac7c2",
    "symbol": "USD",
    "code": 840
  }
}

Get invoices history

Retrieve a list of all invoices

GEThttps://api.simplepay.ai/invoice

Authorization

Response

Successful response

Body

idstring (uuid)

Example: "6bbeeedf-cf2c-44dc-83da-b0dfdd74ddb1"

parent_idnullable string

client_idstring (uuid)

Example: "afbc65e8-7e94-4362-b9dd-454a6c44572e"

fromstring

Example: 5.530779700679296e+47

tostring

Example: 3.944798939560003e+47

amountstring

Example: "0.000334073863731271"

pricestring

Example: "0.80"

typestring

Example: "payment"

statusstring

Example: "success"

tx_hashstring

Example: 4.798213107540505e+76

tx_blockinteger

Example: 20464313

created_atstring (date-time)

Example: "2024-08-05T18:58:49Z"

updated_atstring (date-time)

Example: "2024-08-05T18:58:49Z"

expire_atstring (date-time)

Example: "2024-08-05T19:28:49Z"

cryptocurrencyobject

networkobject

currencyobject

Request

const response = await fetch('https://api.simplepay.ai/invoice', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

[
  {
    "id": "6bbeeedf-cf2c-44dc-83da-b0dfdd74ddb1",
    "parent_id": null,
    "client_id": "afbc65e8-7e94-4362-b9dd-454a6c44572e",
    "from": 5.530779700679296e+47,
    "to": 3.944798939560003e+47,
    "amount": "0.000334073863731271",
    "price": "0.80",
    "type": "payment",
    "status": "success",
    "tx_hash": 4.798213107540505e+76,
    "tx_block": 20464313,
    "created_at": "2024-08-05T18:58:49Z",
    "updated_at": "2024-08-05T18:58:49Z",
    "expire_at": "2024-08-05T19:28:49Z",
    "cryptocurrency": {
      "id": "effbb0b9-1803-4fd2-8bbb-ee5f3430f100",
      "symbol": "ETH",
      "decimals": 18,
      "stable": false
    },
    "network": {
      "id": "7639e9e4-6306-46a9-9acc-cc943d0d0c60",
      "symbol": "ethereum",
      "type": "EVM"
    },
    "currency": {
      "id": "5e091838-d7bb-4365-a395-84d82d1ac7c2",
      "symbol": "USD",
      "code": 840
    }
  }
]

Get invoice by ID

Retrieve an invoice by its ID

GEThttps://api.simplepay.ai/invoice/{invoice_id}

Authorization

Path parameters

invoice_id*string (uuid)

Example: "6bbeeedf-cf2c-44dc-83da-b0dfdd74ddb1"

Response

Successful response

Body

idstring (uuid)

Example: "6bbeeedf-cf2c-44dc-83da-b0dfdd74ddb1"

parent_idnullable string

client_idstring (uuid)

Example: "afbc65e8-7e94-4362-b9dd-454a6c44572e"

fromstring

Example: 5.530779700679296e+47

tostring

Example: 3.944798939560003e+47

amountstring

Example: "0.000334073863731271"

pricestring

Example: "0.80"

typestring

Example: "payment"

statusstring

Example: "success"

tx_hashstring

Example: 4.798213107540505e+76

tx_blockinteger

Example: 20464313

created_atstring (date-time)

Example: "2024-08-05T18:58:49Z"

updated_atstring (date-time)

Example: "2024-08-05T18:58:49Z"

expire_atstring (date-time)

Example: "2024-08-05T19:28:49Z"

cryptocurrencyobject

networkobject

currencyobject

Request

const response = await fetch('https://api.simplepay.ai/invoice/{invoice_id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "id": "6bbeeedf-cf2c-44dc-83da-b0dfdd74ddb1",
  "parent_id": null,
  "client_id": "afbc65e8-7e94-4362-b9dd-454a6c44572e",
  "from": 5.530779700679296e+47,
  "to": 3.944798939560003e+47,
  "amount": "0.000334073863731271",
  "price": "0.80",
  "type": "payment",
  "status": "success",
  "tx_hash": 4.798213107540505e+76,
  "tx_block": 20464313,
  "created_at": "2024-08-05T18:58:49Z",
  "updated_at": "2024-08-05T18:58:49Z",
  "expire_at": "2024-08-05T19:28:49Z",
  "cryptocurrency": {
    "id": "effbb0b9-1803-4fd2-8bbb-ee5f3430f100",
    "symbol": "ETH",
    "decimals": 18,
    "stable": false
  },
  "network": {
    "id": "7639e9e4-6306-46a9-9acc-cc943d0d0c60",
    "symbol": "ethereum",
    "type": "EVM"
  },
  "currency": {
    "id": "5e091838-d7bb-4365-a395-84d82d1ac7c2",
    "symbol": "USD",
    "code": 840
  }
}

Cancel invoice

Cancel invoice by its ID

DELETEhttps://api.simplepay.ai/invoice/{invoice_id}

Path parameters

invoice_id*string (uuid)

Example: "2177ef62-1644-42e7-b1ef-32082110b2fa"

Response

Successful response

Body

idstring (uuid)

Example: "2177ef62-1644-42e7-b1ef-32082110b2fa"

parent_idnullable string

client_idstring (uuid)

Example: "efbc65e8-7e94-4362-b9dd-454a6c44572e"

fromstring

Example: "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz"

tostring

Example: "TQgRam4iNcSJAs9nd3uczxTd29YDouGScd"

amountstring

Example: "1005.648391800613432786"

pricestring

Example: "120.00"

typestring

Example: "payment"

statusstring

Example: "canceled"

tx_hashnullable string

tx_blocknullable string

created_atstring (date-time)

Example: "2024-08-05T09:51:42.762715997Z"

updated_atstring (date-time)

Example: "2024-08-05T09:51:42.762715997Z"

expire_atstring (date-time)

Example: "2024-08-05T10:16:42.762715997Z"

cryptocurrencyobject

networkobject

currencyobject

Request

const response = await fetch('https://api.simplepay.ai/invoice/{invoice_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "2177ef62-1644-42e7-b1ef-32082110b2fa",
  "parent_id": null,
  "client_id": "efbc65e8-7e94-4362-b9dd-454a6c44572e",
  "from": "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz",
  "to": "TQgRam4iNcSJAs9nd3uczxTd29YDouGScd",
  "amount": "1005.648391800613432786",
  "price": "120.00",
  "type": "payment",
  "status": "canceled",
  "tx_hash": null,
  "tx_block": null,
  "created_at": "2024-08-05T09:51:42.762715997Z",
  "updated_at": "2024-08-05T09:51:42.762715997Z",
  "expire_at": "2024-08-05T10:16:42.762715997Z",
  "cryptocurrency": {
    "id": "65992ab6-09e9-460d-8f9a-c6cf1d5627f1",
    "symbol": "TRX",
    "decimals": 18,
    "stable": false
  },
  "network": {
    "id": "0a7a7f1f-56af-495f-b34d-1fc63e85f614",
    "symbol": "tron",
    "type": "TRX"
  },
  "currency": {
    "id": "5e091838-d7bb-4365-a395-84d82d1ac7c2",
    "symbol": "USD",
    "code": 840
  }
}

PreviousGetting Started NextDev Mode

Last updated 2 months ago

const response = await fetch('https://api.simplepay.ai/invoice', { method: 'POST', headers: { "Authorization": "Bearer JWT", "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "id": "2177ef62-1644-42e7-b1ef-32082110b2fa", "parent_id": null, "client_id": "efbc65e8-7e94-4362-b9dd-454a6c44572e", "from": "TEqx4nScnTTjMucmtrq6N5w1Rvt4oYfCnz", "to": "TQgRam4iNcSJAs9nd3uczxTd29YDouGScd", "amount": "1005.648391800613432786", "price": "120.00", "type": "payment", "status": "created", "tx_hash": null, "tx_block": null, "created_at": "2024-08-05T09:51:42.762715997Z", "updated_at": "2024-08-05T09:51:42.762715997Z", "expire_at": "2024-08-05T10:16:42.762715997Z", "cryptocurrency": { "id": "65992ab6-09e9-460d-8f9a-c6cf1d5627f1", "symbol": "TRX", "decimals": 18, "stable": false }, "network": { "id": "0a7a7f1f-56af-495f-b34d-1fc63e85f614", "symbol": "tron", "type": "TRX" }, "currency": { "id": "5e091838-d7bb-4365-a395-84d82d1ac7c2", "symbol": "USD", "code": 840 } }