Manage payment cards on a payer account.

/cnbs/v1/nuvei/customers/id/payer/payment_cards

POST

• Payer Data (payer_data)
  • Customer Number (customer_number)
• Action (action)
  • 01 … Insert new payment card.
  • 02 … Modify existing payment card.
  • 03 … Delete existing payment card.
• Payment Card (payment_card)
  • Token (token)

• Session Card (session_card)
  • true … add card as session card
  • false … add card to customer master account
• Access Token: CNBS API access token (access_token)
• Masked Card Number: (masked_card_number)
• Last four digits: (last_four)
• Billing Info (billing_info_model)
  • Name: (name)
  • E-Mail address: (email_address)
  • City: (city)
  • Address: (address)
  • State: (state)
  • Postal Code City: (zip)
  • Country: (country)
  • Account Type: (account_type)
    • ach … Automated Clearing House (eCheck)
    • cc … Credit card
  • Create profile: (create_profile)
    • true or false
  • Profile ID: (profile_id)
  • Account ID: (account_id)
• Profile ID: (profile_id)
• Account ID: (account_id)
• Custom Fields Table (custom_fields)
  • Key: (key)
  • Value: (value)

To insert or modify a payment card record.

• Default Flag: (default)
  • Payment card default flag in backend customer master data.
• Expiry Date: (expiry_date)
  • Expiry date of the payment card.

• log (log)
  • Event ID (id)
  • login Name (login)
  • ePay Version (epayv)
  • User Agent Str. (usrag)

JSON Payload:

{
    "payer_data": {
        "customer_number": "3000",
        "company_code": "3000"
    },
    "action": "01",
    "payment_card": {
        "access_token": "000C29F0318A1FD082D9DC56890C2B84",
        "session_card": true,
        "token": "11f00aceef7d1cc48bed7475",
        "masked_card_number": "Visa **** **** **** 0002",
        "last_four": "0002",
        "expiry_date": "12-31-2025",
        "billing_info_model": {
            "name": "Smith",
            "email_address": "demo@cnbssoftware.com",
            "city": "MAYWOOD",
            "address": "1 2800 South 25th Ave",
            "state": "IL",
            "zip": "60153",
            "country": "US",
            "account_type": "cc",
            "create_profile": false,
            "profile_id": "11f0001eb6a9a1848808d175",
            "account_id": ""
        },
        "profile_id": "11f00aceefe05e24b90a9950",
        "account_id": "11f00aceef7d1cc48bed7475"
    },
    "log": {
        "id": "ADD_PAYMENT_CARD",
        "login": "user@demo.com",
        "epayv": "v3.1.12",
        "usrag": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
    }
}

cURL

curl -X POST "https://<<your.server.here>>/cnbs/v1/customers/id/payer/payment_cards?sap-client=800&sap-language=EN&apiid=CNBSMV01P" -H  "accept: application/json" -H  "content-type: application/json" -H  "cnbssysid: gPuM1VyY1dxlTE2MEs2yajJUkX3/4+2Pw1alRw4BOtI=" -d "{  \"payer_data\": {    \"customer_number\": \"3050\",    \"company_code\": \"\"  },  \"action\": \"02\",  \"payment_cards\": [    {      \"payment_card_type\": \"AMEX\",      \"payment_card_token\": \"-E803-5144-CQ5FR2X61TWP41\",      \"payment_card_name\": \"John Doe\",      \"valid_from\": \"\",      \"valid_to\": \"05-31-2027\",      \"default\": \"X\",      \"electronic_check_account_type\": \"\",      \"electronic_check_rdfi_number\": \"\",      \"card_validation_code\": \"\"    }  ]}"

• 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.

JSON:

{
  "message_type": "S",
  "message_identification": "/CNBS/X_API",
  "message_number": 10,
  "message_line_string": "Request successfully processed"
}