Check Payment Info

curl --request GET \
  --url https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status \
  --header 'x-api-key: <api_key>'

const response = await fetch(
  "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
  {
    method: "GET",
    headers: {
      "x-api-key": "<api_key>",
    },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
    headers={"x-api-key": "<api_key>"},
)

data = response.json()

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodi78b2000101pjezst1ics",
    "status": "error",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "crypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
    "payer_token_symbol": "USDT",
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994485073732166",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": {
      "family": "evm",
      "chain_name": "arbitrum",
      "schema_version": 1,
      "transactionRequest": {
        "to": "0x23183C87c9c6668edf5974893905AF475c3664c9",
        "from": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "nonce": 36,
        "value": 0,
        "chainId": 42161,
        "gasLimit": "82499",
        "maxFeePerGas": "52514800",
        "maxPriorityFeePerGas": "0"
      }
    },
    "signed_tx": null,
    "global_payment_data": {
      "message": "This details is available only for fiat payments"
    },
    "data_error": {
      "code": "invalid_payment_status",
      "status": "error",
      "details": null,
      "message": "Payment transaction is not in a valid status for execution"
    },
    "metadata": null,
    "created_at": "2026-04-24T22:50:16.910Z",
    "updated_at": "2026-04-24T22:56:40.108Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodhqf38000001pjju9kxlmb",
    "status": "success",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "pixcrypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": "***.***.***-25",
    "tid_hash": "0x3d1dc00ae7cb7bebecd395a264e6656604fdfebb9d1fd7d1bf291601ba31e643",
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05992928344553427",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "paid",
      "confirmed_at": "24/04/2026, 19:39:15",
      "crypto_payment_details": {
        "chain_name": "Arbitrum",
        "amount_usdt": "0.05778",
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "transaction_hash": "0x5d1b672614fb49e36791b89ce63ba2b0e36815e2455c6f3df13a658dd19bcdaa"
      }
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-24T22:37:12.548Z",
    "updated_at": "2026-04-24T22:39:32.225Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodmglpw000101o4sucrw1s0",
    "status": "registered",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "cardcrypto",
    "payer_email": "john.smith.test+pay@example.com",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994005994005994",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "failed",
      "amount": 30,
      "currency": "BRL",
      "charges": [
        {
          "status": "failed",
          "payment_method": "credit_card",
          "last_transaction": {
            "status": "failed",
            "success": false,
            "gateway_response": {
              "code": "400",
              "errors": [
                { "message": "invalid_parameter | amount | valor não permitido" }
              ]
            }
          }
        }
      ]
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-25T00:49:32.660Z",
    "updated_at": "2026-04-25T00:49:46.583Z"
  }
}

GET

payment

{id}

status

curl --request GET \
  --url https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status \
  --header 'x-api-key: <api_key>'

const response = await fetch(
  "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
  {
    method: "GET",
    headers: {
      "x-api-key": "<api_key>",
    },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
    headers={"x-api-key": "<api_key>"},
)

data = response.json()

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodi78b2000101pjezst1ics",
    "status": "error",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "crypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
    "payer_token_symbol": "USDT",
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994485073732166",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": {
      "family": "evm",
      "chain_name": "arbitrum",
      "schema_version": 1,
      "transactionRequest": {
        "to": "0x23183C87c9c6668edf5974893905AF475c3664c9",
        "from": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "nonce": 36,
        "value": 0,
        "chainId": 42161,
        "gasLimit": "82499",
        "maxFeePerGas": "52514800",
        "maxPriorityFeePerGas": "0"
      }
    },
    "signed_tx": null,
    "global_payment_data": {
      "message": "This details is available only for fiat payments"
    },
    "data_error": {
      "code": "invalid_payment_status",
      "status": "error",
      "details": null,
      "message": "Payment transaction is not in a valid status for execution"
    },
    "metadata": null,
    "created_at": "2026-04-24T22:50:16.910Z",
    "updated_at": "2026-04-24T22:56:40.108Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodhqf38000001pjju9kxlmb",
    "status": "success",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "pixcrypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": "***.***.***-25",
    "tid_hash": "0x3d1dc00ae7cb7bebecd395a264e6656604fdfebb9d1fd7d1bf291601ba31e643",
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05992928344553427",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "paid",
      "confirmed_at": "24/04/2026, 19:39:15",
      "crypto_payment_details": {
        "chain_name": "Arbitrum",
        "amount_usdt": "0.05778",
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "transaction_hash": "0x5d1b672614fb49e36791b89ce63ba2b0e36815e2455c6f3df13a658dd19bcdaa"
      }
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-24T22:37:12.548Z",
    "updated_at": "2026-04-24T22:39:32.225Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodmglpw000101o4sucrw1s0",
    "status": "registered",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "cardcrypto",
    "payer_email": "john.smith.test+pay@example.com",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994005994005994",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "failed",
      "amount": 30,
      "currency": "BRL",
      "charges": [
        {
          "status": "failed",
          "payment_method": "credit_card",
          "last_transaction": {
            "status": "failed",
            "success": false,
            "gateway_response": {
              "code": "400",
              "errors": [
                { "message": "invalid_parameter | amount | valor não permitido" }
              ]
            }
          }
        }
      ]
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-25T00:49:32.660Z",
    "updated_at": "2026-04-25T00:49:46.583Z"
  }
}

string

required

Your StarkFi API key. You can find it in your dashboard.

string

required

The unique identifier of the payment transaction.

curl --request GET \
  --url https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status \
  --header 'x-api-key: <api_key>'

const response = await fetch(
  "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
  {
    method: "GET",
    headers: {
      "x-api-key": "<api_key>",
    },
  }
);

const data = await response.json();

import requests

response = requests.get(
    "https://api.starkfi.io/payment/cmodi78b2000101pjezst1ics/status",
    headers={"x-api-key": "<api_key>"},
)

data = response.json()

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodi78b2000101pjezst1ics",
    "status": "error",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "crypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
    "payer_token_symbol": "USDT",
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994485073732166",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": {
      "family": "evm",
      "chain_name": "arbitrum",
      "schema_version": 1,
      "transactionRequest": {
        "to": "0x23183C87c9c6668edf5974893905AF475c3664c9",
        "from": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "nonce": 36,
        "value": 0,
        "chainId": 42161,
        "gasLimit": "82499",
        "maxFeePerGas": "52514800",
        "maxPriorityFeePerGas": "0"
      }
    },
    "signed_tx": null,
    "global_payment_data": {
      "message": "This details is available only for fiat payments"
    },
    "data_error": {
      "code": "invalid_payment_status",
      "status": "error",
      "details": null,
      "message": "Payment transaction is not in a valid status for execution"
    },
    "metadata": null,
    "created_at": "2026-04-24T22:50:16.910Z",
    "updated_at": "2026-04-24T22:56:40.108Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodhqf38000001pjju9kxlmb",
    "status": "success",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "pixcrypto",
    "payer_email": "satoshi@starkfi.io",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": "***.***.***-25",
    "tid_hash": "0x3d1dc00ae7cb7bebecd395a264e6656604fdfebb9d1fd7d1bf291601ba31e643",
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05992928344553427",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "paid",
      "confirmed_at": "24/04/2026, 19:39:15",
      "crypto_payment_details": {
        "chain_name": "Arbitrum",
        "amount_usdt": "0.05778",
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "transaction_hash": "0x5d1b672614fb49e36791b89ce63ba2b0e36815e2455c6f3df13a658dd19bcdaa"
      }
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-24T22:37:12.548Z",
    "updated_at": "2026-04-24T22:39:32.225Z"
  }
}

{
  "statusCode": 200,
  "success": true,
  "status": "payment_found",
  "message": "Payment found.",
  "data": {
    "id": "cmodmglpw000101o4sucrw1s0",
    "status": "registered",
    "executor_id": "api_transaction",
    "order_code": null,
    "transaction_type": "cardcrypto",
    "payer_email": "john.smith.test+pay@example.com",
    "payer_wallet": "",
    "payer_token_symbol": null,
    "payer_cpf": null,
    "tid_hash": null,
    "from_currency_symbol": "BRL",
    "amount_from": "30",
    "amount_to": "0.05994005994005994",
    "to_currency_symbol": "USDT",
    "chain_name": "arbitrum",
    "from_chain": "arbitrum",
    "to_chain": "arbitrum",
    "on_ramp": false,
    "split_payment_config": [
      {
        "receiver_wallet": "0x9b57847b69D0354837F7b723133B9dBCbefb4F9F",
        "receiver_percent": 100
      }
    ],
    "unsigned_tx": null,
    "signed_tx": null,
    "global_payment_data": {
      "status": "failed",
      "amount": 30,
      "currency": "BRL",
      "charges": [
        {
          "status": "failed",
          "payment_method": "credit_card",
          "last_transaction": {
            "status": "failed",
            "success": false,
            "gateway_response": {
              "code": "400",
              "errors": [
                { "message": "invalid_parameter | amount | valor não permitido" }
              ]
            }
          }
        }
      ]
    },
    "data_error": null,
    "metadata": null,
    "created_at": "2026-04-25T00:49:32.660Z",
    "updated_at": "2026-04-25T00:49:46.583Z"
  }
}

Response

number

required

HTTP status code.

boolean

required

Whether the request succeeded.

string

required

Status label for the response (e.g. payment_found).

string

required

Human-readable response message.

object

required

The full payment transaction object.

Show data

string

required

Unique payment ID.

enum<string>

required

Current payment status. Available options: success, error, pending, reproved, registered

string

required

ID of the executor that initiated the transaction.

string | null

Merchant order reference code.

enum<string>

required

Payment method used. Available options: crypto, pixcrypto, cardcrypto, cardfiat

string

required

Payer’s email address.

string

Payer’s blockchain wallet address. Empty for fiat-only transactions.

string | null

Token used by the payer (e.g. USDT). null for fiat payments.

string | null

Masked CPF (Brazilian tax ID). Present only for pixcrypto transactions.

string | null

On-chain transaction hash after successful execution.

string

required

Source currency symbol (e.g. BRL).

string

required

Amount in the source currency.

string

required

Target currency symbol (e.g. USDT).

string

required

Amount in the target currency.

string

required

Destination blockchain network (e.g. arbitrum).

string

required

Source blockchain network.

string

required

Target blockchain network.

boolean

required

Whether this is an on-ramp transaction.

array

Split payment recipients.

Show split_payment_config[]

string

required

Recipient wallet address.

number

required

Percentage allocated to this recipient (0–100).

object | null

Prepared EVM transaction, ready for signing. Present only for crypto type.

Show unsigned_tx

string

Transaction family (e.g. evm).

string

Target chain.

number

Schema version.

object

Raw transaction params: to, from, data, nonce, value, chainId, gasLimit, maxFeePerGas, maxPriorityFeePerGas.

string | null

Signed transaction payload. null until submitted.

object | null

Provider-specific payment data. Structure varies by transaction_type:

crypto — static message string
pixcrypto — Pix charge object + crypto_payment_details
cardcrypto / cardfiat — card processor order, charges, and customer objects

object | null

Error details when status is error.

Show data_error

string

Machine-readable error code.

string

Error status label.

string

Human-readable error message.

string | null

Extended details or stack trace.

string

JWT-signed URL for the hosted payment session page.

object | null

Arbitrary metadata attached at payment creation.

string

required

ISO 8601 creation timestamp.

string

required

ISO 8601 last-updated timestamp.

API documentation

StarkPay

Orders

Yield Aggregator

KYC

Quote

Response

​Response

Response