Creating invoice

POST /api/public/v1/invoices

This endpoint creates invoices.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Request Body

Name	Type	Required	Description
data.type	string	Yes	Can only be invoices.
data.attributes.amountBilled	string	Yes	Invoice amount to display to end users. Determines the amount due after conversion.
data.attributes.billedCurrency	string	Yes	Invoice currency to display to end users. Determines the currency due after conversion. Refer to supported currencies.
data.attributes.chargedCurrency	string	Yes	Crypto currency that customer must pay in. Refer to supported currencies.
data.attributes.network	string	Yes	Payment network. Refer to supported networks.
data.attributes.reference	string	No	The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose. Must be a unique value for each invoice you create.

cURL

curl -X "POST" "https://api.sandbox.txn.pro/api/public/v1/invoices" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer <api_key>' \
     -d $'{
  "data": {
    "type": "invoices",
    "attributes": {
      "billedCurrency": "usd",
      "reference": "9556e207-b785-4faf-9486-8e79fb442e76",
      "network": "TTRX:USDT",
      "amountBilled": "100",
      "chargedCurrency": "USDT"
    }
  }
}'

Response Body

Name	Type	Description
data.id	string	Invoice ID.
data.type	string	Entity type returned. Always invoices.
data.attributes	object	Set of invoice attributes.
data.attributes.amountBilled	string	Invoice amount to display to end users. Determines the amount due after conversion.
data.attributes.amountCharged	string	Amount due. Determines the amount of cryptucurrency the end-user is required to pay.
data.attributes.billedCurrency	string	Invoice currency to display to end users. Determines the currency due after conversion. Refer to supported currencies.
data.attributes.chargedCurrency	string	Crypto currency that customer must pay in. Refer to supported currencies.
data.attributes.reference	string	The custom reference ID to tie the invoice to end-user who pays. This can be anything you choose.
data.attributes.statusContext	string	Invoice status context. Refer to Invoice status flow.
data.attributes.network	string	Network code. Refer to Supported currencies.
data.attributes.networkName	string	Network name to display.
data.attributes.status	string	Invoice status. Refer to Invoice status flow.
data.attributes.paymentStatus	string	Invoice payment status. Refer to Invoice status flow.
data.attributes.exchangeRate	string	Invoice exchange rate valid for 20 minutes.
data.attributes.expiresAt	string	Invoice expiry date and time.
data.attributes.createdAt	string	Date and time invoice was created at.
included.type(addresses).attributes	object	Invocie receiving address. This is the address the end-user must send their crytpocurrency payment to.

Response

HTTP 201

{
  "data": {
    "id": "55f7832f-9745-4553-8548-1a06e30fb251",
    "type": "invoices",
    "attributes": {
      "amountBilled": "1000.00",
      "amountCharged": "1011.233592",
      "billedCurrency": "USD",
      "chargedCurrency": "USDT",
      "reference": "9556e207-b785-4faf-9486-8e79fb442e76",
      "statusContext": "unpaid",
      "network": "TTRX:USDT",
      "networkName": "Tron (TRC20)",
      "status": "pending",
      "paymentStatus": "expecting",
      "exchangeRate": "0.9888912",
      "expiresAt": "2024-06-14T12:50:53.637Z",
      "createdAt": "2024-06-14T12:30:53.693Z"
    },
    "relationships": {
      "address": {
        "data": {
          "type": "addresses",
          "id": "b5c97775-1378-4170-a7f0-78c2c5d60720"
        }
      },
      "invoiceTransactions": {
        "meta": {
          "included": false
        }
      },
      "coinDeposits": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "included": [
    {
      "id": "b5c97775-1378-4170-a7f0-78c2c5d60720",
      "type": "addresses",
      "attributes": {
        "label": "USDT TTRX",
        "value": "TBq5k63KV9q4reE6JEF9e7wTYGo3RUkMQU",
        "createdAt": "2024-06-14T12:18:47.095Z"
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "network": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

HTTP 422

{
  "errors": [
    {
      "status": 422,
      "title": "amount is below minimum",
      "detail": "amount: 10.0, minimum: 30.00",
      "code": "amount_below_minimum"
    }
  ]
}

// Amoun too low.

HTTP 422

{
  "errors": [
    {
      "status": 422,
      "title": "amount is above maximum",
      "detail": "amount: 500000.0, maximum: 100000.00",
      "code": "amount_above_maximum"
    }
  ]
}

// Amount too high.

HTTP 422

{
  "errors": [
    {
      "status": 422,
      "title": "Invalid attribute",
      "detail": "External has already been taken",
      "code": "payout_invalid",
      "source": {
        "pointer": "/data/attributes/externalId"
      }
    }
  ]
}

// Dplicate reference.