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

Set Card PIN

POST
/api/v1/cardoperations/{cardId}/pin/set
Sets or resets the card's PIN. Use this for a first-time PIN or to reset a forgotten PIN without knowing the old one. Direct-API products only — iframe-flow products should use {cardId}/iframe/pin/set instead, where the customer enters the PIN inside a provider-hosted iframe.
⚠️ Required Fields
FieldTypeDescriptionConstraints
pinstringThe new PIN to setMin: 4 · Max: 6
📤 Response Fields
FieldTypeDescription
cardIdstring (uuid)Card identifier
customerIdstring (uuid)Customer identifier
productIdstring(uuid)Product identifier
cardTypestringType of card
cardNumberstring null
actionstringAction performed on the card
statusstringStatus of the PIN operation
messagestringMessage describing the operation result
taskIdstring (uuid)Task identifier
performedAtstring (date-time)Timestamp when the action was performed

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
PIN set successfully.
Bodyapplication/json

🟠401
🟠404
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/cardoperations/6f1c9a2e-4b3d-4e7a-9c5f-1a2b3c4d5e6f/pin/set' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data '{
    "pin": "4821"
}'
Response Response Example
200 - Success
{
    "data": {
        "cardId": "8b1f3d52-9c4e-4a77-b0d2-6e3f1a9c5d41",
        "customerId": "2c7a4f10-88b3-4e91-9d6a-1f5c2b7e3a04",
        "productId": "2c7a4f10-88b3-4e01-9d6a-1f5c2b7e3a04",
        "cardType": "Physical",
        "cardNumber": null,
        "action": "set_pin",
        "status": "PIN Set",
        "message": "Card PIN set successfully.",
        "taskId": "9d4c1f60-2a83-4b57-a0e9-6c73f815d224",
        "performedAt": "2026-09-01T09:14:22.4310000Z"
    }
}
Modified at 2026-09-01 07:06:45
Previous
Activate Card
Next
Change Card PIN
Built with