--- title: "Get Payment by ID" method: GET path: "/v1/payments/{paymentId}" tags: ["Payments"] --- # Get Payment by ID `GET /v1/payments/{paymentId}` The **Get Payment by ID** endpoint allows you to retrieve information about a specific payment transaction using its unique identifier. This endpoint provides comprehensive data on the payment, including its status, method, amount, and currency. ## Path parameters - `paymentId` string, required ## Response `200` OK - InternalResponsePaymentsPaymentResponse - `data` PaymentsPaymentResponse - `amount` string — The amount associated with the payment. - `created_at` string — The timestamp indicating when the payment was created. - `crypto_transaction` ModelsCryptoTransaction - `chain_id` integer — The unique identifier representing a blockchain network or chain. - `created_at` string — The timestamp indicating when the crypto transaction was created. - `id` integer — The unique identifier of the crypto transaction. - `payment_id` SqlNullString - `string` string - `valid` boolean — Valid is true if String is not NULL - `raw` integer[] — Additional raw data associated with the crypto transaction. - `sequence` string — The sequence number of the crypto transaction. - `source` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 — The payment method: - 1 = Unknown - 2 = Merchantcontract - 3 = Proxywallet - 4 = Unblock - 5 = Card - 6 = Googlepay - 7 = Applepay - 8 = Paypal - 9 = Directdebit - 10 = Ramp - 11 = Rampcryptosettlement - `status` 1 | 2 | 3 — The transaction's current models.PaymentStatus: - 1 = Pending - 2 = Success - 3 = Failed - `transaction_hash` string — The transaction hash of the crypto transaction. - `type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — The type of the transaction: - 1 = Unknown - 2 = Approval - 3 = Deposit - 4 = Withdraw - 5 = Payment - 6 = Refund - 7 = Subscribe - 8 = Unsubscribe - 9 = Internal - 10 = Swap - `updated_at` string — The timestamp indicating when the crypto transaction was last updated. - `currency` string — The currency of the payment. - `customer` CustomersCustomerResponse - `created_at` string — The timestamp indicating when the customer was created. - `deleted_at` string — The timestamp indicating when the customer was deleted, if applicable. - `email` string — The email address of the customer. - `id` string — The unique identifier of the customer. - `metadata` object - `name` string — The name of the customer. - `org_id` string — The identifier representing the organization associated with the customer. - `phone` string — The phone number of the customer. - `properties` object — Additional properties associated with the customer. - `reference` string — The reference associated with the customer. - `updated_at` string — The timestamp indicating when the customer was last updated. - `v1` unknown - `wallet_address` string — The wallet address associated with the customer. - `customer_id` string — The ID of the customer associated with the payment. - `id` string — The unique identifier of the payment. - `invoice_id` string — The ID of the invoice associated with the payment. - `next_action` string — The next action related to the payment. - `org_id` string — The ID of the organization associated with the payment. - `parent_id` string — The ID of the parent payment if this payment is a part of a larger transaction. - `payment_link` PaylinksPaymentLinkResponse - `id` string — The unique identifier for the paylink - `plan_id` string — The ID of the associated plan - `invoice_id` string — The ID of the associated invoice - `source` string — The source of the paylink - `customer_ident_collection` boolean — Indicates if customer identification collection is enabled - `shipping_address_collection` boolean — Indicates if shipping address collection is enabled - `tax_ident_collection` boolean — Indicates if tax identification collection is enabled - `enabled` boolean — Indicates if the paylink is enabled - `deleted_at` string, date-time — The timestamp when the paylink was deleted - `created_by` string — The ID of the user who created the paylink - `updated_by` string — The ID of the user who last updated the paylink - `created_at` string, date-time — The timestamp when the paylink was created - `updated_at` string, date-time — The timestamp when the paylink was last updated - `available_quantity` number — The remaining number of times this payment link can be used. `null` indicates unlimited usage. - Decremented on each successful or failed payment. - Restored when a payment is canceled. - When the value reaches zero, the payment link becomes invalid. - `expires_at` string, date-time — The expiration date and time of the payment link. Any checkout attempt after this timestamp will fail. - `metadata` object — Additional metadata associated with the paylink - `properties` object — Additional properties associated with the paylink - `short_code` string — The short code associated with the paylink - `plan` object — The details of the associated plan - `id` string — The unique identifier for the plan - `org_id` string — The organization ID associated with the plan - `source` string — The source of the plan - `name` string — The name of the plan - `type` string — The type of the plan - `billing_scheme` string — The billing scheme of the plan - `price` string — The price of the plan - `currency` string — The currency of the plan - `available_quantity` integer — The available quantity of the plan - `trial_period` string — The trial period of the plan - `recurring_interval` string — The recurring interval of the plan - `recurring_interval_count` integer — The recurring interval count of the plan - `recurring_usage_type` string — The recurring usage type of the plan - `reference` string — The reference of the plan - `enabled` boolean — Indicates if the plan is enabled - `v1` string — Additional information about the plan - `created_by` string — The ID of the user who created the plan - `created_at` string, date-time — The timestamp when the plan was created - `updated_at` string, date-time — The timestamp when the plan was last updated - `deleted_at` string, date-time — The timestamp when the plan was deleted - `metadata` object — Additional metadata associated with the plan - `payment_method` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 — The payment method: - 1 = Unknown - 2 = Merchantcontract - 3 = Proxywallet - 4 = Unblock - 5 = Card - 6 = Googlepay - 7 = Applepay - 8 = Paypal - 9 = Directdebit - 10 = Ramp - 11 = Rampcryptosettlement - `properties` object — Additional properties associated with the payment. - `scheduled_time` integer — The scheduled time for the payment. - `source` 1 | 2 | 3 | 4 — The source of this billing information. Can be one of the following: - 1 = Lago - 2 = Boomfi - 3 = Stripe - 4 = Chargebee - `status` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — The current status of the payment_id: - 1 = Unknown - 2 = Requirespaymentmethod - 3 = Requiresconfirmation - 4 = Requiresaction - 5 = Processing - 6 = Succeeded - 7 = Canceled - 8 = Failed - `updated_at` string — The timestamp indicating when the payment was last updated. - `v1` integer[] — v1 - `error` boolean ## Other responses - `400` — Bad Request - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/boomfi/apis/boomfi-merchants-api.md) · [All operations](https://skmtc.net/boomfi/apis/boomfi-merchants-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/boomfi/boomfi-merchants-api/revisions/ace3c3df05fe/schema)