getPaymentStatus

getPaymentStatus

Path Parameters

serviceSubscriberDepartmentToken string required

serviceSubscriberDepartmentToken

application/json

Request Body required

invoiceId

string

Responses

• 200
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
paymentAttempts object[]
Array [
amount number
attemptDateTime string
attemptNumber int32
cardHolderName string
cardId string
cardType string
currency string
customerId string
failCode string
failDescription string
invoiceAmount number
invoiceId string
lastFour string
paid boolean
paymentStatusTime string
paymentType string
receiptUrl string
roId string
transactionId string
]
signedDocumentUrl string
warnings object[]
Array [
warningCode string
warningDescription string
]

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

Unauthorized

Forbidden

Not Found

Loading...