Payer details
Get payer account details.
URL
/cnbs/v1/customers/id/payer
Method
GET
Parameters
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)
Example
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="
Response
- 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)
- 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.
Example Response
{
"detail": {
"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"
},
"communcation_data": {
"phone": [
{
"country_code": "US",
"standard": "X",
"telephone": "(312)450-BUSH"
}
],
"smtp": [
{
"standard": "X",
"email": "demo@cnbssoftware.com"
},
{
"email": "office@cnbssoftware.com"
}
]
},
"company_data": [
{
"data": {
"company_code": "3000"
}
}
],
"payment_cards": [
{
"payment_card_type": "MC",
"payment_card_token": "-E803-0003-D2H9D3QYYZH66Z",
"payment_card_name": "Test MC",
"valid_from": "08-01-2023",
"valid_to": "02-28-2029",
"last_four": "0003"
}
],
"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"
}
}
]
},
"status": {
"message_type": "S",
"message_identification": "/CNBS/X_API",
"message_number": 10,
"message_line_string": "Request successfully processed"
}
}