Skip to main content

Step 3: Create Card Verification Session

Create a verification session for a stored card. If the card is not yet verified, the API will return a verify_url that you can open (for example, in an iframe) for the customer to complete verification.

Endpoint Information

Name: Create Card Verification Session
Method: POST
URL: {{stg_url}}/api/v1/card-verify/create-session

Authentication

Type: Basic Auth

  • Username: App Key
  • Password: Secret Key

Request Body

Content-Type: application/json

{
"merchantAccountId": "100002",
"cardHolderName": "JHON DOE",
"cardToken": "xxxx",
"customerToken": "xxxx",
"cardVerifyHookUrl": "https://your-webhook-url"
}

Responses

Response – Card Not Verified

{
"success": true,
"message": "success",
"data": {
"is_verified": false,
"verify_url": "https://card-verification.paymid.com?session_id=xxxx",
"expired_at": "YYYY-MM-DD HH:MM:SS"
}
}

Response – Card Already Verified

{
"success": true,
"message": "success",
"data": {
"is_verified": true,
"verify_url": null,
"expired_at": null
}
}

Workflow

  1. Call this API to create a card verification session.
  2. If data.is_verified is false, open the verify_url in an iframe or new window.
  3. Customer completes the verification flow on the hosted verification page.
  4. The system sends a callback to cardVerifyHookUrl with the verification result.
  5. After successful verification, the card can be used for withdrawal and other protected operations.