1. Payment link & Checkout Link
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • Get SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Orders
        • Get Rates
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
      • Payment link & Checkout Link
        • Generate Payment Link
          POST
        • Generate Hosted Checkout
          POST
        • Get Payment Link Details
          GET
    • User Operations
      • Onboarding & KYC Flow
        • Create User Account
        • Method A: Add KYC File
        • Method B: Creating KYC Verification
        • Method B: Redirect to Verification
        • Method B: Get KYC Status
        • Add User Verification
        • Add POA File
      • Account Management
        • Update Existing User
        • Delete User
        • Suspend User
        • Unsuspend User
      • Balances & Transaction History
        • Get User Balances
        • Get User Transaction History
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • GET SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Internal Transfers
        • Create a Transfer
        • Get Transfer Details
      • Virtual Cards
        • Create Virtual Card
        • Get All User Cards
        • Get Card Details
        • Update Card PIN
        • Block Card
        • Unblock Card
        • Get Card Limits
        • Update Card Limits
        • Delete Card
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation Webhook
        • KYC File Added Webhook
        • POA Verification Status Webhook
        • KYC Verification Status Webhook
        • Create Wallet Webhook
        • High Risk KYC Verification Webhook
      • Transfers & Payments Webhooks
        • Internal Transfer Webhook
        • IBAN Status Webhook
        • Partner SEPA Transfer Webhook
        • User SEPA Transfer Webhook
        • SEPA Deposit Webhook
        • Crypto Withdrawal Webhook
        • Crypto Deposit Webhook
        • Exchange Webhook
        • Card Transaction Webhook
        • Order status Webhook
        • Payment Link Webhook
      • Card Webhooks
        • Card 3DS Code Webhook
        • Card Activation Code Webhook
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. Payment link & Checkout Link

Get Payment Link Details

Testing Env
https://partner-api-stage.p100.io
Testing Env
https://partner-api-stage.p100.io
GET
/v1/payment-link/{paymentLinkId}
This endpoint retrieves the comprehensive status and full history of a payment link. The architecture separates the high-level business state from the technical blockchain events:
Payment Link Status (Root): Represents the overall state of the payment process. A link remains in the initial state until the full amount is confirmed or the time expires.
Transaction History (Nested): The transactions array tracks every blockchain transfer detected. These entries provide granular technical details, such as network confirmations and risk analysis, for each individual payment attempt.
Payment Lifecycle Flow:
After a payment link is created, it is assigned the PENDING status. It transitions to SUCCESSFUL once the user correctly completes the payment. If the link’s time limit is reached, it becomes EXPIRED. If a user starts a payment but does not finish it (for example, by not sending the full required amount), the link remains in the PENDING state.
Service Fulfillment
Release your products or services only when the root-level status is SUCCESSFUL. This state guarantees that the total requested amount has been received, confirmed on the blockchain, and fully settled.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Path Params

Responses

🟢200Success
application/json
Body

🟠400P500: Unknown exception
🟠400P501: Service temporarily unavailable
🟠401Access Denied
🟠404P464: Payment link not found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://partner-api-stage.p100.io/v1/payment-link/d1de274a-ea3f-4483-b6c2-160ed20d9099' \
--header 'x-api-key: <api-key>'
Response Response Example
200 - Success
{
    "paymentLinkId": "d1de274a-ea3f-4483-b6c2-160ed20d9099",
    "rate": 0.08514561,
    "amount": "1",
    "paidAmount": "1",
    "status": "SUCCESSFUL",
    "createdAt": "2026-02-26T05:32:43.111Z",
    "expiresAt": "2026-02-26T23:00:00.000Z",
    "reference": "1234",
    "note": null,
    "transactions": [
        {
            "id": "bb85d5bf-a6cc-4be4-99b6-e871fd7d6db9",
            "type": "CRYPTOCURRENCY_DEPOSIT",
            "currencySlug": "doge",
            "amount": 5,
            "amountRate": 0.08520145,
            "transactionHash": "33f1208ff76827672eec023258411a2fef95d94ebb20b33bb6cb815cc0b20ec1",
            "confirmations": 85,
            "status": "SUCCESSFUL",
            "network": "dogecoin",
            "minConfirmations": 5
        },
        {
            "id": "47c5ea18-62c4-4f93-942f-c2da05076c0e",
            "type": "CRYPTOCURRENCY_DEPOSIT",
            "currencySlug": "doge",
            "amount": 6.69441443,
            "amountRate": 0.08518357,
            "transactionHash": "a9ac9428e07d99407de073a50ba2c6074091fe12b7bc193c4508e6c151f02ba4",
            "confirmations": 68,
            "status": "SUCCESSFUL",
            "network": "dogecoin",
            "minConfirmations": 5
        }
    ]
}
Previous
Generate Hosted Checkout
Next
User Operations
Built with