voidCaptureRefund

ApiScope: payment.all
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

application/json

Request Body required

invoiceId string
type string
amount number

Responses

• 200
• 400
• 401
• 422
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]
transactionId string
invoiceId string
amountRefunded string
amountVoided string
amountCaptured string

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "transactionId": "string",
  "invoiceId": "string",
  "amountRefunded": "string",
  "amountVoided": "string",
  "amountCaptured": "string"
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Unprocessable Entity

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /v3/department/:departmentUuid/process

Request

Base URL

/payment

departmentUuid — path required

Body required

{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}

curl / cURL

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

python / requests

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

go / native

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

nodejs / axios

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

ruby / Net::HTTP

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

csharp / RestSharp

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

php / cURL

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

java / OkHttp

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'

powershell / RestMethod

curl -L -X POST '/payment/v3/department/:departmentUuid/process' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "invoiceId": "string",
  "type": "string",
  "amount": 0
}'