Check Payment Info - StarkFi Documentation

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

{
  "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"
  }
}

GET

payment

{id}

status

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

{
  "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"
  }
}

x-api-key

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>'

{
  "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"
  }
}

Response

statusCode

number

required

HTTP status code.

success

boolean

required

Whether the request succeeded.

status

string

required

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

message

string

required

Human-readable response message.

data

object

required

The full payment transaction object.

Show data

string

required

Unique payment ID.

status

enum<string>

required

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

executor_id

string

required

ID of the executor that initiated the transaction.

order_code

string | null

Merchant order reference code.

transaction_type

enum<string>

required

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

payer_email

string

required

Payer’s email address.

payer_wallet

string

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

payer_token_symbol

string | null

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

payer_cpf

string | null

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

tid_hash

string | null

On-chain transaction hash after successful execution.

from_currency_symbol

string

required

Source currency symbol (e.g. BRL).

amount_from

string

required

Amount in the source currency.

to_currency_symbol

string

required

Target currency symbol (e.g. USDT).

amount_to

string

required

Amount in the target currency.

chain_name

string

required

Destination blockchain network (e.g. arbitrum).

from_chain

string

required

Source blockchain network.

to_chain

string

required

Target blockchain network.

on_ramp

boolean

required

Whether this is an on-ramp transaction.

split_payment_config

array

Split payment recipients.

Show split_payment_config[]

receiver_wallet

string

required

Recipient wallet address.

receiver_percent

number

required

Percentage allocated to this recipient (0–100).

unsigned_tx

object | null

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

Show unsigned_tx

family

string

Transaction family (e.g. evm).

chain_name

string

Target chain.

schema_version

number

Schema version.

transactionRequest

object

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

signed_tx

string | null

Signed transaction payload. null until submitted.

global_payment_data

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

data_error

object | null

Error details when status is error.

Show data_error

code

string

Machine-readable error code.

status

string

Error status label.

message

string

Human-readable error message.

details

string | null

Extended details or stack trace.

session_payment

string

JWT-signed URL for the hosted payment session page.

metadata

object | null

Arbitrary metadata attached at payment creation.

created_at

string

required

ISO 8601 creation timestamp.

updated_at

string

required

ISO 8601 last-updated timestamp.

Introduction Register Order Transaction

​Response

Response