Payer details [CNBS DokuWiki]

Get payer account details.

/cnbs/v1/customers/id/payer

GET

Required

Customer Number (customer_number)

Optional

Company Code (company_code)
Action (payer_det_action)
- 01 Get assigned soldto to the payer. If sales area parameters are filled, result list contains only soldto's matching the filter.
Sales Area (sales_area_data)
- Sales Organization (sales_organization)
- Distribution Channel (distribution_channel)
- Division (division)

cURL

curl -X GET "https://<<your.server.here>>/cnbs/v1/customers/id/payer?sap-client=800&sap-language=EN&apiid=CNBSMV01R&customer_number=3050&company_code=3000&payer_det_action=01&sales_organization=3000&distribution_channel=10&division=00" -H  "accept: application/json" -H  "content-type: application/json" -H  "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI="

Detail (detail)
- Address data (address_data)
  - Name (name)
  - Name 2 (name_2)
  - Name 3 (name_3)
  - Name 4 (name_4)
  - City (city)
  - District (district)
  - Street (street)
  - Postal Code City (postal_code_city)
  - Region (region)
  - Country (country)
- Communication data (communication_data)
  - Phone (phone)
    - Country code (country_code)
    - Standard flag (standard)
    - Telephone No (telephone)
  - E-Mail addresses (smtp)
    - Standard flag (standard)
    - E-Mail address (email)
- Company Data Table (company_data)
  - Data (data)
    - Company Code (company_code)
- Payment Card Table (payment_cards)
  - Payment Card Type (payment_card_type)
    - Payment card type used for this transaction.
  - Payment Card Token (payment_card_token)
    - Tokenized payment card.
  - Payment Card Name (payment_card_name)
    - Full name of the payment card holder.
  - Payment Card Valid-From (valid_from)
    - Valid from date of the payment card.
  - Payment Card Valid-To (valid_to)
    - Expiry date of the payment card.
  - Default
    - X … Default Card
  - Last Four (last_four)
    - Last four digits

Only for payment provider Worldpay

Electronic Check Account Type (electronic_check_account_type)
- C … Consumer Checking Account (U.S. and Canada)
- S … Consumer Savings Account (U.S. only)
- X … Corporate Checking Account (U.S. only)
Electronic Check Routing Number (electronic_check_rdfi_number)
- Receiving Depository Financial Institution Number.

Only for payment provider Nuvei

Nuvei (nuvei)
- Masket Card Number (masked_card_number)
- Profile ID (profile_id)
- Account ID (account_id)
- Account Type (acount_type)
  - ach … Automated Clearing House (eCheck)
  - cc … Credit Card
- SAP Merchant ID

Soldto List Table(soldto_list)
- Customer Number (customer_number)
- Sales Area data (sales_area_data)
  - Sales Organization (sales_organization)
  - Distribution Channel (distribution_channel)
  - Division (division)
- Address data (address_data)
  - Name (name)
  - Name 2 (name_2)
  - City (city)
  - District (district)
  - Street (street)
  - Postal Code City (postal_code_city)
  - Region (region)
  - Country (country)
Auto Pay Enrollment Status (auto_pay_status)
- Company Code (company_code)
- Payment Method (payment_method)
- Entrolled (entrolled)
Status (status)
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.

{
  "detail": {
    "address_data": {
      "name": "Bush Holdings, Inc.",
      "city": "CHICAGO",
      "district": "COOK",
      "street": "1 408 Michigan Avenue",
      "postal_code_city": "60611",
      "region": "IL",
      "country": "US"
    },
    "communcation_data": {
      "phone": [
        {
          "country_code": "US",
          "standard": "X",
          "telephone": "555-111-1234"
        }
      ],
      "smtp": [
        {
          "standard": "X",
          "email": "bush.holdings@mailinator.com"
        }
      ]
    },
    "company_data": [
      {
        "data": {
          "company_code": "3000"
        }
      }
    ],
    "payment_cards": [
      {
        "payment_card_type": "AMEX",
        "payment_card_token": "-E803-6666-SVM1G19XT9YR4W",
        "payment_card_name": "TEST 33",
        "valid_from": "02-01-2025",
        "valid_to": "01-31-2029",
        "last_four": "6666"
      },
      {
        "payment_card_type": "AMEX",
        "payment_card_token": "-E803-9001-QKBTNDAD3HNP2M",
        "payment_card_name": "AMEX TEST 4",
        "valid_from": "02-01-2025",
        "valid_to": "01-31-2029",
        "last_four": "9001"
      },
      {
        "payment_card_type": "EC",
        "payment_card_token": "-E803-1122-J59YXQBQS6JY1A",
        "payment_card_name": "Test Chris",
        "valid_from": "12-01-2024",
        "valid_to": "12-31-9999",
        "electronic_check_account_type": "X",
        "electronic_check_rdfi_number": "122000234",
        "last_four": "1122"
      },
      {
        "payment_card_type": "EC",
        "payment_card_token": "-E803-1123-F395GWD914AF75",
        "payment_card_name": "Test Number three2",
        "valid_from": "02-01-2025",
        "valid_to": "12-31-9999",
        "default": "X",
        "electronic_check_account_type": "S",
        "electronic_check_rdfi_number": "122000247",
        "last_four": "1123"
      },
      {
        "payment_card_type": "EC",
        "payment_card_token": "-E803-4456-82V0TCR3VF6S34",
        "payment_card_name": "TEST EC 3",
        "valid_from": "02-01-2025",
        "valid_to": "12-31-9999",
        "electronic_check_account_type": "X",
        "electronic_check_rdfi_number": "123456789",
        "last_four": "4456"
      },
      {
        "payment_card_type": "MC",
        "payment_card_token": "-E803-4555-4BFQ0Q6BFQTD6B",
        "payment_card_name": "Test 789",
        "valid_from": "04-01-2025",
        "valid_to": "01-31-2027",
        "last_four": "4555"
      }
    ],
    "soldto_list": [
      {
        "customer_number": "0000003000",
        "sales_area_data": {
          "sales_organization": "3000",
          "distribution_channel": "10",
          "division": "00"
        },
        "address_data": {
          "name": "Smith Inc. LLC",
          "name_2": "Test",
          "city": "MAYWOOD",
          "district": "COOK",
          "street": "1 2800 South 25th Ave",
          "postal_code_city": "60153",
          "region": "IL",
          "country": "US"
        }
      },
      {
        "customer_number": "0000003001",
        "sales_area_data": {
          "sales_organization": "3000",
          "distribution_channel": "10",
          "division": "00"
        },
        "address_data": {
          "name": "Industrial Supplies Inc.",
          "name_2": "Name2",
          "name_3": "Name3",
          "name_4": "Name4",
          "city": "VIRGINIA BEACH",
          "district": "VIRGINIA BEACH (IND",
          "street": "1345 Main St.",
          "postal_code_city": "23456",
          "region": "VA",
          "country": "US"
        }
      },
      {
        "customer_number": "0000003008",
        "sales_area_data": {
          "sales_organization": "3000",
          "distribution_channel": "10",
          "division": "00"
        },
        "address_data": {
          "name": "Altoids",
          "city": "Cincinnati",
          "street": "895 Central Ave",
          "postal_code_city": "45220",
          "country": "US"
        }
      }
    ],
    "auto_pay_status": [
      {
        "company_code": "3000",
        "payment_method": "CC",
        "enrolled": true
      },
      {
        "company_code": "3000",
        "payment_method": "EC",
        "enrolled": false
      }
    ]
  },
  "status": {
    "message_type": "S",
    "message_identification": "/CNBS/X_API",
    "message_number": 10,
    "message_line_string": "Request successfully processed"
  }
}

Payer details

URL

Method

Parameters

Required

Optional

Example

Response

Example Response