1. Operations
Artha All Module Api's
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Products
    • List Products
      GET
    • Get Product
      GET
    • Get Customer Product Status
      GET
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Submit Applicant (KYC/KYB)
      POST
    • Create Onboarding Session
      POST
  • Wallets
    • Beneficiary
      • Create Crypto Beneficiary
      • Update Crypto Beneficiary
      • List Crypto Withdraw Beneficiaries
    • Create Wallet
    • Get Wallet Address
    • Get Customer Balances
    • List Wallets
    • List Withdrawals
    • List Withdrawal Networks
    • Preview Withdrawal Summary
    • Create Crypto Withdrawal
  • Cards
    • Issuance
      • Issue Card
      • List Cards
      • List Customer Cards
      • Get Card Details
      • Get Sensitive Card Details
    • Funding
      • Top Up Card
      • Get Card Balance
      • Get Top-Up Status
      • List Top-Up History
    • Operations
      • Resend Activation Code
        POST
      • Activate Card
        POST
      • Set Card PIN
        POST
      • Change Card PIN
        POST
      • Update Card Limits
        POST
      • Freeze Card
        POST
      • Unfreeze Card
        POST
      • Replace Card
        POST
      • Cancel Card
        POST
      • Get Card Limits
        GET
      • Show Card PIN Details
        GET
      • Get PIN View Iframe URL
        GET
      • Get PIN Change Iframe URL
        GET
      • Get PIN Set Iframe URL
        GET
      • Get Card View Iframe URL
        GET
      • Show Card PIN
        GET
  • Payees
    • Create a payee for a customer.
    • List a customer's payees.
    • Update a payee.
    • Retrieve a payee by id.
    • Look up an existing payee.
    • List the currencies a payee can be created in.
    • List the accepted payment purpose codes for a payee.
    • List the countries a payee can be created in.
    • List currency/country pairings for payees.
    • List the accepted beneficiary relationship codes.
  • Payments
    • Onboarding
      • List the customer's payout-currency configuration sections.
      • Enable a payout-currency section for the customer.
      • Get the customer's terms-of-service acceptance status.
      • Enable or disable a payout-currency section.
    • Quote
      • List the currencies a beneficiary can be paid in under a product.
      • List the payout rails available for a product and beneficiary.
      • Create an FX quote giving the rate and fee for a cross-currency payout.
    • Order
      • Submit a payout order to send money to a beneficiary.
      • Retrieve the on-chain address to fund an order.
      • Retrieve the status and settlement detail of a payout order.
    • Lookups
      • List the accepted payment purpose codes for a payout.
      • List the accepted source-of-funds codes for a payout.
      • List the document types accepted on a payout order.
  • Banks
    • Accounts
      • Create Bank Account
      • Get Account Details
      • Get Account Issuance Status
    • Withdraw
      • Create Withdrawal Quote
      • List Withdrawal Purposes
      • Get Payment Schemes
      • Execute Withdrawal
  • Exchange
    • Quote
      • Get Exchange Rate
      • Create Price Quote
    • Order
      • Place Exchange Order
  • Transactions
    • List Transactions
    • Get Transaction Details
  • Utilities
    • List Currencies
    • List Countries
    • Get Fee Schedule
    • List Product Occupations
    • List Product Industry Codes
    • Upload File
  • Webhook's
    • Wallets Webhooks
    • Banks Webhooks
    • Payments Webhooks
    • Exchange Webhooks
    • Card Webhooks
  1. Operations

Get PIN View Iframe URL

GET
/api/v1/cardoperations/{cardId}/iframe/pin/view
Returns the provider-hosted iframe URL to view the card PIN. Iframe-flow products only — the customer reads the PIN inside the iframe and no PIN value passes through this API. Direct-API products receive iframeUrl: null; read {cardId}/pin/details instead.
This is the view counterpart of {cardId}/iframe/pin/set (which starts the set/reset flow) and resolves through the same show-PIN call as pin/details.
📤 Response Fields
FieldTypeDescription
idstring (uuid)Card identifier
iframeUrlstringProvider-hosted iframe URL, or null for direct-API products

Request

Path Params

Header Params

Responses

🟢200
application/json
Iframe URL returned.
Bodyapplication/json

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/cardoperations/6f1c9a2e-4b3d-4e7a-9c5f-1a2b3c4d5e6f/iframe/pin/view' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
200 - Success
{
    "id": "6f1c9a2e-4b3d-4e7a-9c5f-1a2b3c4d5e6f",
    "iframeUrl": "https://issuer-provider.example.com/iframe/pin/view?session=a1b2c3d4"
}
Modified at 2026-09-01 03:29:04
Previous
Show Card PIN Details
Next
Get PIN Change Iframe URL
Built with