---
updatedAt: 2025-06-18T12:39:16.000Z
agentTools:
  projectIndex: https://developer.pay.nl/llms.txt
---

# getAuthenticationStatus

If the integrated 3DSecure is used for authentication this API can be used to get the status of the 3DSecure session.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "PAY. Card Payment API - v1.2.3",
    "termsOfService": "https://www.pay.nl/algemene-voorwaarden",
    "contact": {
      "email": "support@pay.nl"
    },
    "version": "1.2"
  },
  "servers": [
    {
      "url": "https://payment.pay.nl/"
    }
  ],
  "paths": {
    "/v1/Payment/getAuthenticationStatus/json": {
      "post": {
        "tags": [
          "Card Payments"
        ],
        "summary": "getAuthenticationStatus",
        "description": "If the integrated 3DSecure is used for authentication this API can be used to get the status of the 3DSecure session.",
        "operationId": "9127090d4da0784100517935a43fd1e7",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AuthenticationStatus"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthenticationStatusResponse"
                },
                "examples": {
                  "AuthenticationStatusResponsePending": {
                    "$ref": "#/components/examples/AuthenticationStatusResponsePending"
                  },
                  "AuthenticationStatusResponseAuthenticate": {
                    "$ref": "#/components/examples/AuthenticationStatusResponseAuthenticate"
                  },
                  "AuthenticationStatusResponseAuthorize": {
                    "$ref": "#/components/examples/AuthenticationStatusResponseAuthorize"
                  },
                  "AuthenticationStatusResponseFailed": {
                    "$ref": "#/components/examples/AuthenticationStatusResponseFailed"
                  },
                  "AuthenticationStatusResponseExpired": {
                    "$ref": "#/components/examples/AuthenticationStatusResponseExpired"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request. See response for details."
          },
          "401": {
            "description": "Unauthorized."
          },
          "403": {
            "description": "Forbidden."
          },
          "404": {
            "description": "Not found."
          }
        },
        "security": [
          {
            "basicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AuthenticationStatus": {
        "properties": {
          "transactionId": {
            "description": "",
            "type": "string",
            "example": "728d9cb9-9840-2165-8d10-72872e1642fb"
          }
        },
        "type": "object"
      },
      "AuthenticationStatusResponse": {
        "properties": {
          "request": {
            "$ref": "#/components/schemas/RequestResponse"
          },
          "threeDs": {
            "properties": {
              "transactionID": {
                "description": "",
                "type": "string",
                "example": "728d9cb9-9840-2165-8d10-72872e1642fb"
              },
              "transactionStatusCode": {
                "description": "",
                "type": "string",
                "example": ""
              }
            },
            "type": "object"
          }
        },
        "type": "object"
      },
      "RequestResponse": {
        "properties": {
          "result": {
            "description": "Indicates whether the request was successfully processed (`1`) or some error has occurred (`0`).",
            "type": "integer"
          },
          "errorId": {
            "description": "If the request was not successfully processed this parameter holds the ID of the error that has occurred. ",
            "type": "string"
          },
          "errorTag": {
            "description": "The error tag can be used to generate an error response for the customer.",
            "type": "string"
          },
          "errorMessage": {
            "description": "Description of the error that occurred. This message is returned in the language (if available) in which the transaction is/was submitted.",
            "type": "string"
          }
        },
        "type": "object",
        "example": [
          {
            "result": 1,
            "errorId": "",
            "errorTag": "",
            "errorMessage": ""
          },
          {
            "result": 0,
            "errorId": "PAY-2011",
            "errorTag": "invalidRequest",
            "errorMessage": "Invalid request; amount is missing in payload or value is not accepted. Amount must be a positive integer."
          }
        ]
      }
    },
    "examples": {
      "AuthenticationStatusResponsePending": {
        "summary": "Status pending",
        "value": {
          "request": {
            "result": "1",
            "errorId": "",
            "errorTag": "",
            "errorMessage": ""
          },
          "threeDs": {
            "transactionID": "728d9cb9-9840-2165-8d10-72872e1642fb",
            "transactionStatusCode": "10",
            "nextAction": "pending"
          }
        }
      },
      "AuthenticationStatusResponseAuthorize": {
        "summary": "Status authorize",
        "value": {
          "request": {
            "result": "1",
            "errorId": "",
            "errorTag": "",
            "errorMessage": ""
          },
          "threeDs": {
            "transactionID": "728d9cb9-9840-2165-8d10-72872e1642fb",
            "transactionStatusCode": "100",
            "nextAction": "authorize"
          }
        }
      },
      "AuthenticationStatusResponseAuthenticate": {
        "summary": "Statuc authenticate",
        "value": {
          "request": {
            "result": "1",
            "errorId": "",
            "errorTag": "",
            "errorMessage": ""
          },
          "threeDs": {
            "transactionID": "728d9cb9-9840-2165-8d10-72872e1642fb",
            "transactionStatusCode": "25",
            "nextAction": "authenticate"
          }
        }
      },
      "AuthenticationStatusResponseFailed": {
        "summary": "Authentication failed",
        "value": {
          "request": {
            "result": "0",
            "errorId": "PAY-2425",
            "errorTag": "authenticationFailed",
            "errorMessage": ""
          },
          "threeDs": {
            "transactionID": "728d9cb9-9840-2165-8d10-72872e1642fb",
            "transactionStatusCode": "-10",
            "nextAction": "failed"
          }
        }
      },
      "AuthenticationStatusResponseExpired": {
        "summary": "Authentication expired",
        "value": {
          "request": {
            "result": "0",
            "errorId": "PAY-2423",
            "errorTag": "threeDSSessionExpired",
            "errorMessage": ""
          },
          "threeDs": {
            "transactionID": "728d9cb9-9840-2165-8d10-72872e1642fb",
            "transactionStatusCode": "",
            "nextAction": ""
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "tags": [
    {
      "name": "Card Payments"
    }
  ],
  "externalDocs": {
    "description": "Official PAY. documentation",
    "url": "https://docs.pay.nl"
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```