Retrieve the application data specification for a payment method

curl --request GET \
  --url https://mock-merchant-api-portal-dev.d.eks.aws.cld.resurs.com/v2/stores/{store_id}/payment_methods/{payment_method_id}/application_data_specification \
  --header 'Authorization: Bearer <token>'

{
  "elements": [
    {
      "type": "TEXT",
      "label": "Social security number",
      "fieldName": "applicant-government-id",
      "description": "Social security number for the customer, format YYYMMDD",
      "required": true,
      "pattern": "^((3[0-1])|([1-2][0-9])|(0[1-9]))((1[0-2])|(0[1-9]))(\\d{2})?([\\d]{4})$",
      "patternValidationErrorMessage": "Not a valid name of the applicant",
      "defaultValue": "SINGLE",
      "options": [
        {
          "label": "Student / Studying",
          "value": "STUDENT",
          "checked": true,
          "description": "Student or Studying at any type of level"
        }
      ],
      "maxLength": 100,
      "min": 1,
      "max": 100,
      "requiredIfValue": {
        "fieldName": "applicant-government-id",
        "pattern": ".*"
      }
    }
  ]
}

Advanced usage - Payment methods

Retrieve the application data specification for a payment method

<p>Retrieves the application data specification for a specific payment method based on the provided amount. This specification can include information relevant for a new credit application or a limit raise.</p> <p>The endpoint requires the ID of the store, the ID of the payment method, and the amount for which the application is being made. The amount may impact the application form returned by the API.</p> <p>The response contains an array of form elements with information about the fields required for the application. The elements have a type, label, description, and other properties depending on the field type. The response may be empty if the application data specification for the payment method is not available. <h2>Form types</h2> <h3>HEADING</h3> <p> The header type is a kind of label that works as a title for different sections in the form</p> <h3>TEXT</h3> <p>The text type is a standard type, which allows most characters. The type will be returned in, for example, an input field where the customer can input their e-mail or government ID.</p> <h3>NUMBER</h3> <p>The number type is a type which only accepts numbers. The type will be returned in, for example, an input field where the customer is required to input their income.</p> <h3>LIST</h3> <p>The list type contains a list of multiple choices, which can be used to select a value. The type will be returned in, for example, an select menu with different options where the customer is required to select one of the options.</p> <h3>CHECKBOX</h3> <p>The checkbox type can contain multiple single values that can be turned on and off independently. The type will be returned in, for example, an input field where multiple choices can to be presented.</p> <h3>TOGGLE</h3> <p>The toggle types preferred use is for enabling collection of further information. The type will be returned in, for example, an input field that can be used to toggle between an active or inactive state to change the form layout depending on if a co-applicant is apparent</p> ## Authorization `@accessController.hasAccessToStore(#storeId)`

GET

stores

{store_id}

payment_methods

{payment_method_id}

application_data_specification

Retrieve the application data specification for a payment method

curl --request GET \
  --url https://mock-merchant-api-portal-dev.d.eks.aws.cld.resurs.com/v2/stores/{store_id}/payment_methods/{payment_method_id}/application_data_specification \
  --header 'Authorization: Bearer <token>'

{
  "elements": [
    {
      "type": "TEXT",
      "label": "Social security number",
      "fieldName": "applicant-government-id",
      "description": "Social security number for the customer, format YYYMMDD",
      "required": true,
      "pattern": "^((3[0-1])|([1-2][0-9])|(0[1-9]))((1[0-2])|(0[1-9]))(\\d{2})?([\\d]{4})$",
      "patternValidationErrorMessage": "Not a valid name of the applicant",
      "defaultValue": "SINGLE",
      "options": [
        {
          "label": "Student / Studying",
          "value": "STUDENT",
          "checked": true,
          "description": "Student or Studying at any type of level"
        }
      ],
      "maxLength": 100,
      "min": 1,
      "max": 100,
      "requiredIfValue": {
        "fieldName": "applicant-government-id",
        "pattern": ".*"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

store_id

string

required

The UUID of the store Unique identifier of the store

Example:

"123e4567-e89b-12d3-a456-426655440000"

payment_method_id

string

required

The ID of the payment method

Example:

"111e4567-e89b-12d3-a456-426655441111"

Query Parameters

amount

number<decimal>

required

The amount to apply for

Example:

100

Response

elements

object[]

Show child attributes

Retrieve personalized payment methods for a specific customer Retrieve available payment methods by store and purchase amount

Merchant API v2

Stores endpoints

OAuth2 endpoints

Retrieve the application data specification for a payment method

Authorizations

Path Parameters

Query Parameters

Response