Retrieve Payment Option Details

GET 
/payment-options

Retrieves the payment option details per processing entity.

Request

Query Parameters

processing_entity_id uuidrequired

ID of processing entity.

country_code string

Possible values: >= 2 characters and <= 2 characters

The 2-letter ISO country code.

currency string

Possible values: >= 3 characters and <= 3 characters

The 3-letter ISO currency code.

include_optional_fields boolean
Include optional fields in the response
Default value: false

Responses

200

OK

application/json

Schema

Schema

paymentOptions

object[]

Array [

name stringrequired

Possible values: <= 50 characters

isDirect boolean

Indication if the Payment Option supports direct flow

Default value: false

supportsFieldsRecovery booleanrequired

Indication if the Payment Option supports fields recovery functionality

Default value: false

fields

object[]

List of input fields for a Payment Option

Array [

name stringrequired

The name of the input parameter as expected by REST API methods

Possible values: <= 100 characters

dataType stringrequired

The data type of the value

Possible values: [INTEGER, DECIMAL, STRING, DATE, BOOLEAN, OBJECT, LIST]

isMandatory booleanrequired

Indication if the field is required for the Payment Option

minimumLength integer

The minimum supported length of the provided value. Valid for STRING data type

maximumLength integer

The maximum supported length of the provided value. Valid for STRING data type

values

object[]

Array [

code string

Possible values: <= 50 characters

displayName string

Possible values: <= 100 characters

mandatoryFields string[]

Possible values: <= 100 characters

]

]

restrictions

object[]

Array [

countryCode string

Possible values: >= 2 characters and <= 2 characters

currency string

Possible values: >= 3 characters and <= 3 characters

minimumAmount number

maximumAmount number

]

logoUrl string

]

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "paymentOptions": [
    {
      "name": "string",
      "isDirect": false,
      "supportsFieldsRecovery": false,
      "fields": [
        {
          "name": "string",
          "dataType": "INTEGER",
          "isMandatory": true,
          "minimumLength": 0,
          "maximumLength": 0,
          "values": [
            {
              "code": "string",
              "displayName": "string",
              "mandatoryFields": [
                "string"
              ]
            }
          ]
        }
      ],
      "restrictions": [
        {
          "countryCode": "string",
          "currency": "string",
          "minimumAmount": 0,
          "maximumAmount": 0
        }
      ],
      "logoUrl": "string"
    }
  ],
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

result

object

required

status stringrequired

Possible values: [success, error]

errors

object

code string

If an error occurred on the request side, an error code is returned in this parameter.

Possible values: <= 11 characters

Example: 7000.1000

reason string

If an error occurred on the request side, then an error reason is returned in this parameter.

Possible values: <= 400 characters

Example: Unexpected error

Example (from schema)

{
  "result": {
    "status": "success",
    "errors": {
      "code": "7000.1000",
      "reason": "Unexpected error"
    }
  }
}

Loading...