Run Payisland Rules

ApiScope: payment.rules.payisland
API Scope Level: ServiceSubscriberScope

application/json

Request Body required

invoiceGUID string
ccLastFour string
ipAddress string
onlinePayment boolean
customerFirstName string
customerLastName string
cardholderFirstName string
cardholderLastName string

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]
payislandResponse object
cardTypeAvailableOnline string[]
blockOnlinePayment boolean
runPayislandRules boolean
customerBlocked boolean
declinePayment boolean
sendToGateway boolean
sendNotification boolean

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ],
  "payislandResponse": {
    "cardTypeAvailableOnline": [
      "string"
    ],
    "blockOnlinePayment": true,
    "runPayislandRules": true,
    "customerBlocked": true,
    "declinePayment": true,
    "sendToGateway": true,
    "sendNotification": true
  }
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

POST /kpayment/v1/firePayislandRules

Request

Base URL

/payment

Body required

{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}

curl / cURL

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

python / requests

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

go / native

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

nodejs / axios

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

csharp / RestSharp

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

php / cURL

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

java / OkHttp

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'

powershell / RestMethod

curl -L -X POST '/payment/kpayment/v1/firePayislandRules' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceGUID": "string",
  "ccLastFour": "string",
  "ipAddress": "string",
  "onlinePayment": true,
  "customerFirstName": "string",
  "customerLastName": "string",
  "cardholderFirstName": "string",
  "cardholderLastName": "string"
}'