Returns the details of a scheduled payment ID.

/cnbs/v1/invoices/scheduled_paym/id

GET

• Payer (payer_data)
  • Payer Number (customer_number)
  • Company Code (company_code)
• Scheduled Payment ID (schedule_id)

cURL:

curl -X GET "https://deveselling.cnbssoftware.com/cnbs/v1/invoices/scheduled_paym/id?sap-client=800&sap-language=EN&apiid=CNBSMV01R&payer_number=3050&company_code=3000&schedule_id=4" -H  "accept: application/json" -H  "cnbssysid: W1B//vRKywJ2sPUVQG4CQ16Sf9XSN+N4Fkc6Bfmky3k="

• Scheduled Payment ID (scheduled_id)
• Scheduled Date (scheduled_date)
• Scheduled Status (scheduled_status)
  • O … Open
  • D … Deleted
  • E … Error
  • S … Sucess
• Scheduled Status Details (scheduled_status_detail)
  • Message Type (message_type)
    • SAP Message Type.
      • Errors:
        • E = Error
        • A = Abort
        • X = Exception
      • Others:
        • S = Success
        • W = Warning
        • I = Information
  • Message Identifier (message_identification)
    • SAP Message ID.
  • Message Number (message_number)
    • SAP Message Number.
  • Message Line (message_line_string)
    • SAP Message Text.
• Payment Detail (payment_detail)
  • See request parameter service Make payment
• Scheduled Documents (scheduled_documents)
  • See request parameter service Make payment
• Status (status)
  • CNBS API standard response

JSON:

{
  "scheduled_id": 4,
  "scheduled_date": "07-03-2025",
  "scheduled_status": "E",
  "scheduled_status_detail": [
    {
      "message_type": "E",
      "message_identification": "/CNBS/X_API",
      "message_number": 36,
      "message_line_string": "Approval not received for payment card type AMEX ending in 6666 amount USD 1660.000."
    }
  ],
  "payment_detail": {
    "payment_method": "CC",
    "payment_card_type": "AMEX",
    "payment_card_token": "-E803-6666-SVM1G19XT9YR4W",
    "payment_card_name": "TEST 33",
    "valid_to": "01-31-2029",
    "address_data": {
      "name": "Circuit (USD)",
      "name_2": "null",
      "city": "Cincinnati",
      "district": "HAMILTON",
      "street": "895 Central Avenue",
      "postal_code_city": "45202",
      "region": "OH",
      "country": "US"
    }
  },
  "scheduled_documents": [
    {
      "document_number_finance": "1400003710",
      "line_item_in_the_relevant_invoice": 1,
      "fiscal_year_of_the_relevant_invoice": 2022,
      "open_amount": 1660,
      "amount_to_process": 1660,
      "currency_key": "USD"
    }
  ],
  "status": {
    "message_type": "S",
    "message_identification": "/CNBS/X_API",
    "message_number": 10,
    "message_line_string": "Request successfully processed"
  }
}