Create Card Not Present Processing

post

https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/processors/cnp

Configures a card-not-present (CNP) processor for a location, enabling e-commerce and gateway payments. The response provisions the gateway client and API credentials that the E-commerce endpoints use to obtain a gateway token.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer YOUR_ACCESS_TOKEN
Content-Type	Yes	`application/json`

Request Parameters

Path Parameters:

Parameter	Type	Required	Description
location_id	integer	Yes	Location to configure.

Request Body Fields:

Field	Type	Required	Description
type	string	Yes	Must be `CNP` for card-not-present.
processor	string	Yes	Processor identifier (for example, `RC` for First Data, or `Cybersource`).
status	integer	Yes	`1` = active.
merchant_id	string	Yes	Merchant identifier with the processor.
environment	string	Yes	Processor environment (`Development`, `Demo`, `Production`).
api_key	string	Conditional	API key, when required by the processor.
password	string	Conditional	Shared secret, when required.
pay_by_card	integer	No	Enable card payments (`1`/`0`).
user_id	integer	No	The acting user.

Request Example

{
  "type": "CNP",
  "processor": "RC",
  "status": 1,
  "merchant_id": "54983156468810",
  "environment": "Development",
  "pay_by_card": 1,
  "user_id": 144
}

cURL Example

curl --request POST \
  --url https://sandbox-api.softpoint.io/interface/v1/locations/273394/processors/cnp \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "type": "CNP",
    "processor": "RC",
    "status": 1,
    "merchant_id": "54983156468810",
    "environment": "Development",
    "pay_by_card": 1
  }'

Success Response

A First Data (RC) configuration returns gateway credentials:

{
  "id": 12804,
  "location_id": "273394",
  "processor": "First Data",
  "environment": "Development",
  "name": "CNP",
  "status": 1,
  "merchant_id": "54983156468810",
  "pay_by_card": 1,
  "gtw_client": "iframe_gtw",
  "gtw_api_key": "xsPrypbdTYF068DtM7R9OiJCQEZkA4ah",
  "gtw_api_secret": "REDACTED"
}

A Cybersource configuration instead returns api_key, password, and iframe/wallet flags (sp_iframe, google_pay, apple_pay).

Response Fields

Field	Type	Description
id	integer	Processor configuration ID.
location_id	string	integer
processor	string	Resolved processor name.
environment	string	Processor environment.
name	string	Configuration name.
status	integer	Status.
merchant_id	string	Merchant identifier.
pay_by_card	integer	Whether card payments are enabled.
gtw_client	string	Gateway client type (for example, `iframe_gtw`). Use as the `client` value when generating a gateway token.
gtw_api_key	string	Gateway API key. Use as the `api_key` value when generating a gateway token.
gtw_api_secret	string	Gateway API secret. Store securely.
api_key / password	string	Credentials returned for processors such as Cybersource.
sp_iframe / google_pay / apple_pay	integer	Wallet and iframe capability flags (Cybersource).

Error Responses

Missing Required Parameters

{
  "error": {
    "code": 10109,
    "message": "The request is missing one or more required parameter(s).",
    "details": { "type": ["missing_required_parameters"] }
  }
}

Status Codes

Code	Description
200	Processor configured
400	Required parameters missing
401	Token missing or invalid

Workflow Placement

The bridge between boarding and e-commerce payments:

Create A Location
Create Card Not Present Processing → returns gtw_client and gtw_api_key
E-commerce → Generate Gateway Token (using those values)
E-commerce → Sale / Authorize

Notes

Capture gtw_client and gtw_api_key from the response; they are the client and api_key inputs to Generate Gateway Token.
gtw_api_secret is sensitive; store it server-side only.

Common Mistakes

Omitting type (must be CNP).
Discarding the gateway credentials, which are required to authenticate against the Gateway API.

Responses

200OK

defaultdefault