getPaymentStatus

getPaymentStatus

Path Parameters

serviceSubscriberDepartmentToken string required

Query Parameters

invoiceId string required

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
]
paymentAttempts object[]
Array [
attemptNumber int32
attemptDateTime string
paymentType string
paid boolean
amount number
invoiceAmount number
currency string
cardType string
lastFour string
cardHolderName string
failCode string
failDescription string
invoiceId string
roId string
customerId string
transactionId string
cardId string
receiptUrl string
paymentStatusTime string
]
signedDocumentUrl string

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "paymentAttempts": [
    {
      "attemptNumber": 0,
      "attemptDateTime": "string",
      "paymentType": "string",
      "paid": true,
      "amount": 0,
      "invoiceAmount": 0,
      "currency": "string",
      "cardType": "string",
      "lastFour": "string",
      "cardHolderName": "string",
      "failCode": "string",
      "failDescription": "string",
      "invoiceId": "string",
      "roId": "string",
      "customerId": "string",
      "transactionId": "string",
      "cardId": "string",
      "receiptUrl": "string",
      "paymentStatusTime": "string"
    }
  ],
  "signedDocumentUrl": "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"
    }
  ]
}

Loading...