Retrieve Payment Option Details.
GET/paymentOptions
Retrieves the payment option details per processing entity.
Request
Query Parameters
ID of processing entity.
Possible values: >= 2 characters
and <= 2 characters
Include optional fields in the response
Responses
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
]
paymentOptions
object[]
Possible values: <= 50 characters
Indication if the Payment Option supports direct flow
Indication if the Payment Option supports fields recovery functionality
fields
object[]
List of input fields for a Payment Option
Possible values: <= 100 characters
The name of the input parameter as expected by REST API methods
Possible values: [INTEGER
, DECIMAL
, STRING
, DATE
, BOOLEAN
, OBJECT
, LIST
]
The data type of the value
Indication if the field is required for the Payment Option
The minimum supported length of the provided value. Valid for STRING data type
The maximum supported length of the provided value. Valid for STRING data type
values
object[]
Possible values: <= 50 characters
Possible values: <= 100 characters
Possible values: <= 100 characters
restrictions
object[]
Possible values: >= 2 characters
and <= 2 characters
Possible values: >= 3 characters
and <= 3 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"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"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}