API docs by Redocly

Finassets API Documentation (1.0.0)

Introduction

API Overview

Use the Finassets API to manage balances, deposit addresses, withdrawals, payment requests, and webhook notifications.

This documentation describes available endpoints, authentication requirements, request and response examples, and error responses.

API Endpoints

  • Live - https://www.finassets.io/api
  • Testnet - https://stage.finassets.io/api (basic auth required, contact support)

Authentication

The Finassets API uses an API key and secret key to authenticate requests. Both values are required to sign API requests.

Before API requests can be sent, an API key must be created in the Back Office under Settings > Integration & API Docs by clicking Add API Key.

If the developer responsible for the API integration does not have the required Back Office access, an authorized workspace user must create the API key and provide the required key details to the developer.

Important: Save the secret key when it is displayed. It cannot be shown again.

All requests must contain:

  • Query parameter:

    • request_uuid - Request unique identifier as a string (max 50 chars)

  • Headers:

    • API-Key - The API key
    • Api-Signature - Value of Base64Encode(HMAC-SHA512 on string(request_uuid + request_type + request_uri_part) using SECRET_KEY)

Api-Signature generation example:

  • request_uuid - 'db2f924d-b3bb-4f73-a4c1-7a144f6f01cd'
  • request_type - 'GET'
  • request_uri_part - 'api/v1/account/address'
  • secret_key - 'dcdbbd81b36d1ae66ec8b381b272ae7c/IgzXNJ9K2BfCHkQ'
  • Api-Signature - 74gjMlNjIFoIJSjAL9k7s1yHHzkojNp2Np5EnWHv7NaROKhaGk4S025hjJzil9BQk+6VyhImgsIorfjTRe2g7w==

PHP: base64_encode(hash_hmac('sha512', $request_uuid . $request_type . $request_uri_part, $secret_key, true))
Python: base64.b64encode(hmac.new(Secret.encode('utf-8'), (request_uuid+request_type+request_uri_part).encode('utf-8'), hashlib.sha512).digest()).decode()

IP-Based Access Restrictions

The Finassets platform supports IP-based access restrictions for API calls. For each API key, you can specify which source IP addresses are allowed to send requests.

IP restrictions are configured for an existing API key in the Back Office under Settings > Integration & API Docs. You can add up to 10 authorized IP addresses for each API key.

Requests sent from unregistered IP addresses are rejected.

Limitations

The rate limit is 100 requests per minute.

Account

Retrieve Account Information

Returns account status, enabled deposit and withdrawal features, fee settings, and balances across withdrawal, deposit, and exchange wallets.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "keyword": "TEST1",
  • "active": true,
  • "deposit": true,
  • "withdraw": false,
  • "depositFee": "1.00",
  • "withdrawFee": "2.00",
  • "balances": [
    ],
  • "depositBalances": [ ],
  • "exchangeBalances": [ ]
}

Retrieve Available Assets

Returns enabled assets for the account, including asset name, currency, network, decimal precision, deposit and withdrawal availability, withdrawal limits, and other asset attributes.

For reference, the list of assets is also available in the Back Office under Settings > Integration & API Docs > API Assets.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve or Generate a Deposit Address

Returns the user’s existing deposit address or creates one if no address exists.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

asset
required
string

Name of the asset.

userId
required
string <= 45 characters

User unique ID.

replace
boolean
Default: false

If true, the user's existing deposit address will be replaced with a new one only when the current address is blocked due to AML.

Responses

Response samples

Content type
application/json
{
  • "userId": "1234567",
  • "asset": "BTC_TEST",
  • "address": "tb1qvwe700h2q4n3urcjyh7c4xs35zmjj6sm9kh48a",
  • "legacyAddress": "mpc8i5gpjYyaoV5Jvtux7nmb6H8qHKx2yU"
}

Validate an Address

Validates an address for the specified asset.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
asset
string

Name of the asset.

address
string

Address.

Responses

Request samples

Content type
application/json
{
  • "asset": "BTC_TEST",
  • "address": "tb1qvwe700h2q4n3urcjyh7c4xs35zmjj6sm9kh48a"
}

Response samples

Content type
application/json
{
  • "success": true
}

Sweep Funds from Deposit Wallets

Moves funds from deposit wallets to the account’s withdrawal or exchange balance. Use to=withdrawal (default) or to=exchange to select the destination balance.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
asset
string

Name of the asset.

feeLevel
string or null
Default: "MEDIUM"
Enum: "LOW" "MEDIUM" "HIGH"

Blockchain fee level.

to
string or null
Default: "withdrawal"
Enum: "withdrawal" "exchange"

Destination wallet type.

Responses

Request samples

Content type
application/json
{
  • "asset": "string",
  • "feeLevel": "LOW",
  • "to": "withdrawal"
}

Response samples

Content type
application/json
{
  • "success": true
}

Transactions

List Transactions

Returns deposit, withdrawal, invoice, and checkout transactions.

By default, the request returns transactions with all available statuses and all supported transaction types: deposit, withdraw, invoice, and checkout. The default limit is 10 records. The custom limit can be set from 10 to 250 records.

To narrow the results, filter the response by transaction status, transaction type, asset, or a combination of these filters.

Note: Deposit transactions are incoming transactions created when clients send funds to deposit addresses provided by the Retrieve or Generate a Deposit Address request. Invoice and checkout transactions represent payments received for the corresponding invoice or checkout. Withdrawal transactions are outgoing transactions created through the Create a Transaction request.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

status
string
Enum: "COMPLETED" "FAILED" "SUBMITTED" "CONFIRMING"

Transaction status.

type
string
Enum: "deposit" "withdraw" "invoice" "checkout"

Type of the transaction.

asset
string

Name of the asset.

limit
integer [ 10 .. 250 ]
Default: 10

Maximum number of transactions to be returned.

offset
integer
Default: 0

Offset the result set by a specific number of items.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a Transaction

Creates a withdrawal transaction.

The request must include the asset, amount, and destination address. Optional parameters include destination tag, fee level, reference ID, user ID, and fee inclusion settings.

A destination tag may be required for assets such as XRP (Ripple) and supported TON-network assets. To support internal tracking, an internal transaction reference ID can be provided in the refId field.

Fee inclusion settings define whether the network fee or service fee is deducted from the requested amount.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
asset
required
string

Name of the asset.

amount
required
string

Amount to withdraw. Number format: 123.456 (up to 8 decimal places).

address
required
string

Destination address.

tag
string

Destination tag for XRP (Ripple) and TON.

feeLevel
string
Default: "MEDIUM"
Enum: "LOW" "MEDIUM" "HIGH"

Blockchain fee level.

refId
string <= 45 characters

Reference ID.

userId
string <= 45 characters

User unique ID.

includeFee
boolean
Default: false

If set to true the network fee will be deducted from the requested amount.

includeServiceFee
boolean
Default: false

If set to true the service fee will be deducted from the requested amount.

Responses

Request samples

Content type
application/json
{
  • "asset": "string",
  • "amount": "string",
  • "address": "string",
  • "tag": "string",
  • "feeLevel": "LOW",
  • "refId": "string",
  • "userId": "string",
  • "includeFee": false,
  • "includeServiceFee": false
}

Response samples

Content type
application/json
{
  • "id": 56789
}

Retrieve a Transaction

Returns a transaction by ID, regardless of its status.

path Parameters
id
required
integer

Transaction ID.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "id": 56789,
  • "asset": "ETH_TEST",
  • "amount": "0.02",
  • "networkFee": "0.0000281",
  • "feeAsset": "ETH_TEST",
  • "sourceAddress": "0x883437edFbd974gg1eA88a30c7580d2d4def7058",
  • "destinationAddress": "0x70Fecd618b6844A166f08Ea72DFaF4882D3F080a",
  • "txId": "80c39a0262e67b78a39c6cfa45ddc2478492ac8fb987910559450d918335c472",
  • "status": "COMPLETED",
  • "subStatus": "",
  • "type": "withdraw",
  • "refId": "123",
  • "userId": "123456",
  • "createdAt": "2022-01-10 16:14:11",
  • "updatedAt": "2022-01-10 16:14:55"
}

Set a reference ID

Assigns a refId to an existing deposit transaction.

Use this request to link a Finassets deposit transaction to an internal transaction record in your system and simplify further tracking.

path Parameters
id
required
integer

Transaction ID.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
refId
string <= 45 characters

Reference ID.

required
any

Responses

Request samples

Content type
application/json
{
  • "refId": "string",
  • "required": null
}

Response samples

Content type
application/json
{
  • "success": true
}

Invoices

An invoice is a payment request shared with a customer through an invoice link.

Use invoice-related requests to create, list, and retrieve invoice payment requests.

Important: A Project Key is required to create invoice payment requests. Use an Invoice project for invoice requests. The Project Key is generated when the project is created in the Back Office under Payment Gateway > Projects.

If the developer responsible for the API integration does not have the required Back Office access, an authorized workspace user must provide the required Project Key.

Generated invoice expiration time depends on the Payment waiting time value configured during project creation.

List All Invoices

Returns invoices for the account.

By default, the request returns invoices with all available statuses and a limit of 10 records. The custom limit can be set from 10 to 250 records.

To narrow the results, filter the response by invoice status.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Invoice status.

project
string

Project key.

limit
integer [ 10 .. 250 ]
Default: 10

Maximum number of invoices to be returned.

offset
integer
Default: 0

Offset the result set by a specific number of items.

Responses

Response samples

Content type
application/json
Example

List of invoices.

[
  • {
    },
  • {
    }
]

Create an Invoice

Creates an invoice and returns its payment URL.

The request must include a project key and at least one item. A maximum of 100 items is allowed.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
key
required
string

Project key.

required
Array of objects (InvoiceItem) <= 100 items

Invoice items.

Array (<= 100 items)
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

orderId
string

Reference order ID.

total
string

Total amount to be paid. Number format: 123.456 (up to 8 decimal places). If this field is not provided, the total will be calculated based on the prices of the items.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "items": [
    ],
  • "orderId": "string",
  • "total": "string"
}

Response samples

Content type
application/json
Example

Live invoice url example.

{}

Retrieve an Invoice

Returns an invoice by ID, regardless of its status.

path Parameters
id
string

Invoice ID.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "vq29J0gYWG3nM4UWTiC7UmC8IdJoBu",
  • "amount": "5.1",
  • "received": "0",
  • "currency": "USD",
  • "items": [
    ],
  • "status": "ACTIVE",
  • "project": "QUbO2DU9gzkfEeWbF9X2",
  • "orderId": "ORDER12345",
  • "transactions": [ ],
  • "expiresAt": "2023-04-26 17:35:26",
  • "createdAt": "2023-04-24 17:35:26",
  • "updatedAt": "2023-04-24 17:35:26"
}

Checkout

The Checkout section includes requests for creating, listing, and retrieving checkout payment requests.

Important: A Project Key is required to create checkout payment requests. Use a Checkout project for checkout requests. The Project Key is generated when the project is created in the Back Office under Payment Gateway > Projects.

If the developer responsible for the API integration does not have the required Back Office access, an authorized workspace user must provide the required Project Key.

Generated checkout expiration time depends on the Payment waiting time value configured during project creation.

List All Checkouts

Returns checkouts for the account.

By default, the request returns checkouts with all available statuses and a limit of 10 records. The custom limit can be set from 10 to 250 records.

To narrow the results, filter the response by checkout status.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Checkout status.

project
string

Project key.

limit
integer [ 10 .. 250 ]
Default: 10

Maximum number of checkouts to be returned.

offset
integer
Default: 0

Offset the result set by a specific number of items.

Responses

Response samples

Content type
application/json
Example

List of checkout.

[
  • {
    },
  • {
    }
]

Create a Checkout

Creates a checkout and returns its payment URL.

The request must include a project key and at least one item. A maximum of 100 items is allowed.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Request Body schema: application/json
key
required
string

Project key.

required
Array of objects (InvoiceItem) <= 100 items

Checkout items.

Array (<= 100 items)
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

orderId
string

Reference order ID.

total
string

Total amount to be paid. Number format: 123.456 (up to 8 decimal places). If this field is not provided, the total will be calculated based on the prices of the items.

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "items": [
    ],
  • "orderId": "string",
  • "total": "string"
}

Response samples

Content type
application/json
Example

Live checkout url example.

{}

Retrieve a Checkout

Returns a checkout by ID, regardless of its status.

path Parameters
id
string

Checkout ID.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "id": "vq29J0gYWG3nM4UWTiC7UmC8IdJoBu",
  • "amount": "5.1",
  • "received": "0",
  • "currency": "USD",
  • "items": [
    ],
  • "status": "ACTIVE",
  • "project": "QUbO2DU9gzkfEeWbF9X2",
  • "orderId": "ORDER12345",
  • "transactions": [ ],
  • "expiresAt": "2023-04-26 17:35:26",
  • "createdAt": "2023-04-24 17:35:26",
  • "updatedAt": "2023-04-24 17:35:26"
}

Webhooks

Set up Webhooks

To receive transaction webhook notifications, register a webhook URL in Settings > Integration & API Docs.

If the developer responsible for the API integration does not have the required Back Office access, an authorized workspace user must configure the webhook URL or provide the required setup details.

Transaction webhooks are delivered to the Webhook URL configured in Settings > Integration & API Docs.

Invoice and checkout webhooks are delivered to the Callback URL configured for the corresponding project.

All webhooks are sent with the following header:

Finassets-Signature: Base64-encoded HMAC-SHA512 signature generated from the JSON body using SECRET_KEY.

A webhook delivery attempt is considered successful when your system returns an HTTP 200 status code within 30 seconds. A response body is not required. Any other status code is considered a failed delivery attempt.

If a webhook delivery attempt fails, Finassets resends the request according to the following retry schedule: after 1, 5, 10, 20, 40, 60, 120, 240, 360, 480, and 600 minutes.

Transaction created Webhook

Transaction created.

Note: webhooks are sent only for deposit and withdrawal transactions.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "TRANSACTION_CREATED"
object (TransactionWebhook)
id
integer

Transaction unique ID.

asset
string

Name of the asset.

amount
string

Transaction amount.

networkFee
string

The fee paid to the network.

feeAsset
string

The asset in which the network fee was paid.

sourceAddress
string

The source address of the transaction.

destinationAddress
string

The address where the funds were sent.

txId
string

Blockchain transaction hash.

status
string

Current transaction status.

subStatus
string

Detailed status for FAILED transactions.

type
string

Type of the transaction (deposit or withdraw).

refId
string

Reference ID. Empty string by default, can be set via API.

userId
string or null

User unique ID. Can be NULL if the tag for XRP (Ripple) is invalid.

Request samples

Content type
application/json
{
  • "type": "TRANSACTION_CREATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "transaction": {
    }
}

Transaction updated Webhook

Transaction updated.

Note: webhooks are sent only for deposit and withdrawal transactions.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "TRANSACTION_UPDATED"
object (TransactionWebhook)
id
integer

Transaction unique ID.

asset
string

Name of the asset.

amount
string

Transaction amount.

networkFee
string

The fee paid to the network.

feeAsset
string

The asset in which the network fee was paid.

sourceAddress
string

The source address of the transaction.

destinationAddress
string

The address where the funds were sent.

txId
string

Blockchain transaction hash.

status
string

Current transaction status.

subStatus
string

Detailed status for FAILED transactions.

type
string

Type of the transaction (deposit or withdraw).

refId
string

Reference ID. Empty string by default, can be set via API.

userId
string or null

User unique ID. Can be NULL if the tag for XRP (Ripple) is invalid.

Request samples

Content type
application/json
{
  • "type": "TRANSACTION_UPDATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "transaction": {
    }
}

Transaction failed Webhook

Transaction failed.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "TRANSACTION_FAILED"
object (TransactionWebhook)
id
integer

Transaction unique ID.

asset
string

Name of the asset.

amount
string

Transaction amount.

networkFee
string

The fee paid to the network.

feeAsset
string

The asset in which the network fee was paid.

sourceAddress
string

The source address of the transaction.

destinationAddress
string

The address where the funds were sent.

txId
string

Blockchain transaction hash.

status
string

Current transaction status.

subStatus
string

Detailed status for FAILED transactions.

type
string

Type of the transaction (deposit or withdraw).

refId
string

Reference ID. Empty string by default, can be set via API.

userId
string or null

User unique ID. Can be NULL if the tag for XRP (Ripple) is invalid.

Request samples

Content type
application/json
{
  • "type": "TRANSACTION_FAILED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "transaction": {
    }
}

Invoice created Webhook

Invoice created.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "INVOICE_CREATED"
object (InvoiceWebhook)
id
string

Invoice unique ID.

amount
string

Invoice total amount.

received
string

Received amount.

currency
string

Fiat currency in which the invoice amount is calculated.

Array of objects (InvoiceItem)

Invoice item list.

Array
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Current invoice status.

project
string

Project key.

orderId
string or null

Reference order ID.

Array of objects (PaymentTransaction)

Completed transactions associated with the invoice.

Array
id
integer

Transaction unique ID.

currency
string

Transaction currency.

network
string

Transaction network.

amount
string

Transaction amount.

txId
string

Blockchain transaction hash.

sourceAddress
string

The source address of the transaction.

expiresAt
string

Invoice due date (UTC).

Request samples

Content type
application/json
{
  • "type": "INVOICE_CREATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "data": {
    }
}

Invoice updated Webhook

Invoice updated.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "INVOICE_UPDATED"
object (InvoiceWebhook)
id
string

Invoice unique ID.

amount
string

Invoice total amount.

received
string

Received amount.

currency
string

Fiat currency in which the invoice amount is calculated.

Array of objects (InvoiceItem)

Invoice item list.

Array
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Current invoice status.

project
string

Project key.

orderId
string or null

Reference order ID.

Array of objects (PaymentTransaction)

Completed transactions associated with the invoice.

Array
id
integer

Transaction unique ID.

currency
string

Transaction currency.

network
string

Transaction network.

amount
string

Transaction amount.

txId
string

Blockchain transaction hash.

sourceAddress
string

The source address of the transaction.

expiresAt
string

Invoice due date (UTC).

Request samples

Content type
application/json
{
  • "type": "INVOICE_UPDATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "data": {
    }
}

Checkout Created Webhook

Checkout created.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "CHECKOUT_CREATED"
object (CheckoutWebhook)
id
string

Checkout unique ID.

amount
string

Checkout total amount.

received
string

Received amount.

currency
string

Fiat currency in which the checkout amount is calculated.

Array of objects (InvoiceItem)

Checkout item list.

Array
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Current checkout status.

project
string

Project key.

orderId
string or null

Reference order ID.

Array of objects (PaymentTransaction)

Completed transactions associated with the checkout.

Array
id
integer

Transaction unique ID.

currency
string

Transaction currency.

network
string

Transaction network.

amount
string

Transaction amount.

txId
string

Blockchain transaction hash.

sourceAddress
string

The source address of the transaction.

expiresAt
string

Checkout due date (UTC).

Request samples

Content type
application/json
{
  • "type": "CHECKOUT_CREATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "data": {
    }
}

Checkout updated Webhook

Checkout updated.

Request Body schema: application/json
request_uuid
string

Webhook unique identifier.

datetime
string

Webhook date (UTC).

type
required
string

Webhook type.

Value: "CHECKOUT_UPDATED"
object (CheckoutWebhook)
id
string

Checkout unique ID.

amount
string

Checkout total amount.

received
string

Received amount.

currency
string

Fiat currency in which the checkout amount is calculated.

Array of objects (InvoiceItem)

Checkout item list.

Array
name
string

Name of the item.

quantity
integer

Amount of items.

price
string

Price of the item.

image_url
string

Image URL of the item (Optional). Supported extensions: jpg, jpeg, png, gif, webp, avif

status
string
Enum: "ACTIVE" "PAID" "UNDERPAID" "EXPIRED" "CLOSED" "PENDING_APPROVAL" "CANCELED"

Current checkout status.

project
string

Project key.

orderId
string or null

Reference order ID.

Array of objects (PaymentTransaction)

Completed transactions associated with the checkout.

Array
id
integer

Transaction unique ID.

currency
string

Transaction currency.

network
string

Transaction network.

amount
string

Transaction amount.

txId
string

Blockchain transaction hash.

sourceAddress
string

The source address of the transaction.

expiresAt
string

Checkout due date (UTC).

Request samples

Content type
application/json
{
  • "type": "CHECKOUT_UPDATED",
  • "request_uuid": "b5eda2ac-d397-425c-b162-4ae0727f88a4",
  • "datetime": "2022-01-23 14:20:33",
  • "data": {
    }
}

Resend failed

Resend all failed webhooks.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "webhookCount": 2
}

Resend a transaction

Resend all webhooks for a specific transaction.

path Parameters
id
required
integer

Transaction ID.

query Parameters
request_uuid
required
string <= 50 characters

Request unique identifier.

Responses

Response samples

Content type
application/json
{
  • "webhookCount": 2
}