Skip to main content
GET
/
v1
/
payments
/
{paymentId}
{
  "paymentId": "pmt_abc123xyz",
  "object": "payment",
  "amount": "15075",
  "assetCode": "USDC",
  "method": "OTHER",
  "status": "COMPLETED",
  "provider": "Stripe",
  "providerPaymentId": "pi_3JZ...",
  "description": "Monthly subscription fee",
  "initiatedAt": "2025-04-28T10:00:00.000Z",
  "processedAt": "2025-04-28T10:05:00.000Z",
  "completedAt": "2025-04-28T10:05:30.123Z",
  "metadata": {
    "orderId": "ORD-9876",
    "customerId": "cust_5432"
  },
  "createdAt": "2025-04-28T09:59:50.500Z",
  "updatedAt": "2025-04-28T10:05:30.123Z"
}

Path Parameters

​
paymentId
string
required

The unique identifier of the payment, prefixed with "pmt_"

Response

The request has succeeded.

Represents a payment transaction within the system. Records the movement of funds between accounts or external parties.

​
paymentId
string
required

Unique identifier for the payment transaction, prefixed with "pmt_".

​
object
enum<string>
required

String representing the type of object, always "payment" for payment objects.

Available options:
payment
​
amount
string
required

The amount of the payment in asset subunits. Precision depends on the asset.

​
assetCode
string
required

The code identifying the asset or currency used for the payment (e.g., "USD", "BTC").

​
method
enum<string>
required

The method used for executing the payment (e.g., CRYPTO, OTHER). The method used to make the payment.

Available options:
CRYPTO,
OTHER
​
status
enum<string>
required

The current status of the payment (e.g., COMPLETED, FAILED). This field is typically managed by the system based on transaction processing. Represents the final status of a payment transaction.

Available options:
COMPLETED,
FAILED
​
metadata
object
required

A flexible object for storing additional custom key-value data related to the payment. Defaults to an empty object {} if not provided.

​
createdAt
string<date-time>
required

Timestamp when the payment record was created in the system.

​
updatedAt
string<date-time>
required

Timestamp when the payment record was last updated.

​
provider
string

Optional: The external payment provider used, if any (e.g., "Stripe", "Coinbase").

​
providerPaymentId
string

Optional: The unique identifier for the payment transaction within the external provider's system.

​
description
string

Optional: A description or memo for the payment.

​
initiatedAt
string<date-time>

Timestamp when the payment process was initiated. May be null if initiation tracking differs.

​
processedAt
string<date-time>

Timestamp when the payment processing by the provider or internal system began. May be null.

​
completedAt
string<date-time>

Timestamp when the payment reached a final state (COMPLETED or FAILED). May be null if not yet finalized.

⌘I