updatePaymentAttempt

ApiScope: payment.paymentattempt.update
API Scope Level: ServiceSubscriberScope

Path Parameters

paymentAttempt int64 required

application/json

Request Body required

amount number
status string

Possible values: [Created, RequiresAction, Processing, Successful, Failed, Exception, GatewayException]

surchargeAmount number
salesTaxAmount number
attributes object
property name* string

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

object

{}

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"
    }
  ]
}

PUT /kpayment/v1/paymentAttempts/:paymentAttempt

Request

Base URL

/payment

paymentAttempt — path required

Body required

{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}

curl / cURL

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

python / requests

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

go / native

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

nodejs / axios

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

ruby / Net::HTTP

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

csharp / RestSharp

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

php / cURL

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

java / OkHttp

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'

powershell / RestMethod

curl -L -X PUT '/payment/kpayment/v1/paymentAttempts/:paymentAttempt' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "amount": 0,
  "status": "Created",
  "surchargeAmount": 0,
  "salesTaxAmount": 0,
  "attributes": {}
}'