Overview

🚧

Attention

The method is deprecated and should not be used in new integrations.

Use the following method to create an applicant action that includes specific information about the payment method.

Use this endpoint to add information to the payment method.

This may be helpful when you need to request a specific payment method from the user, so you can send the data that will be shown to the user as a hint.

Request example

curl -X POST \
  'https://api.sumsub.com/resources/applicantActions/5e022e0f0a975a45325c7ff5/paymentMethod' \
  -H 'Content-Type: application/json' \
  -d '{
        "type": "bankCard",
        "subType": "VISA",
        "data": {
          "requiredIdDoc": {
            "firstName": "John",
            "lastName": "Doe",
            "number": "4321434321"
          }
        }
      }'

Response explained

If the request is successfully sent and processed, in the response, you will get a JSON file with the object containing fields with added data.

For example:

{
  "type": "bankCard",
  "subType": "VISA",
  "data": {
    "requiredIdDoc": {
      "firstName": "John",
      "lastName": "Doe",
      "number": "123456789",
      "txnAmount": "100"
    }
  }
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error.

For example:

{
  "description": "Invalid id '123'",
  "code": 400,
  "correlationId": "862b2746b0430c87759627227a9bddc3"
}