Create Card Present Processing

Configures a card-present payment processor for a location, enabling transactions on physical terminals.

Request Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_ACCESS_TOKEN
Content-TypeYesapplication/json

Request Parameters

Path Parameters:

ParameterTypeRequiredDescription
location_idintegerYesLocation to configure.

Request Body Fields:

FieldTypeRequiredDescription
typestringYesProcessing type. Must be CP for card-present.
processorstringYesProcessor identifier. RC = First Data (Rapid Connect), Cybersource = Cybersource.
statusintegerYes1 = active, 0 = inactive.
merchant_idstringYesMerchant identifier (long MID) with the processor.
environmentstringYesProcessor environment. Demo = sandbox, Development, or Production = live merchants.
api_keystringConditionalCybersource REST API key. Required when the processor requires it (for example, Cybersource).
passwordstringConditionalCybersource secret key. Required when the processor requires it.
namestringNoName identifying this processor within the location. Defaults to the value sent in type.
terminal_idstringNoUnique ID assigned by Fiserv (First Data) to identify a terminal.
TTP_idstringNoRapid Connect ID assigned by Fiserv (First Data) for a specific version of vendor/merchant software.
group_idstringNoID assigned by Fiserv (First Data) to identify the individual merchant or group of merchants.
pay_by_cardintegerNoEnables Credit Card as a payment option in SoftPoint apps for CP payments. 1 = active, 0 = inactive.
user_idintegerNoID of the current (acting) user.

Request Example

{
  "type": "CP",
  "processor": "Cybersource",
  "status": 1,
  "merchant_id": "vpctestingsoftpoint005",
  "api_key": "50783f5b-d79a-4279-acc7-ad6693864546111",
  "password": "REDACTED_SHARED_SECRET",
  "environment": "Demo",
  "pay_by_card": 1,
  "user_id": 144
}

cURL Example

curl --request POST \
  --url https://sandbox-api.softpoint.io/interface/v1/locations/279685/processors \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "type": "CP",
    "processor": "Cybersource",
    "status": 1,
    "merchant_id": "vpctestingsoftpoint005",
    "api_key": "YOUR_PROCESSOR_API_KEY",
    "password": "YOUR_PROCESSOR_SECRET",
    "environment": "Demo",
    "pay_by_card": 1
  }'

Success Response

Example for a Cybersource configuration:

{
  "id": 11930,
  "location_id": 279685,
  "processor": "Visa Cybersource",
  "environment": "Demo",
  "name": "CP",
  "status": 1,
  "merchant_id": "vpctestingsoftpoint005",
  "api_key": "50783f5b-d79a-4279-acc7-ad6693864546111",
  "api_secret_key": "REDACTED",
  "terminal_id": null,
  "TTP_id": null,
  "group_id": null,
  "pay_by_card": 1
}

A First Data (RC) configuration returns the processor as First Data along with terminal_id, TTP_id, and group_id.

Response Fields

FieldTypeDescription
idintegerProcessor configuration ID.
location_idintegerLocation it belongs to.
processorstringResolved processor name.
environmentstringProcessor environment.
namestringConfiguration name. Defaults to the value sent in type.
statusintegerStatus. 1 = active, 0 = inactive.
merchant_idstringMerchant identifier.
api_key / api_secret_keystringCredentials (present for processors that use them).
terminal_id / TTP_id / group_idstringFiserv (First Data) identifiers; null for Cybersource.
pay_by_cardintegerWhether card payments are enabled.

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

CodeDescription
200Processor configured
400Required parameters missing
401Token missing or invalid

Workflow Placement

Boarding step that enables in-person payments:

  1. Create A Location

  2. Create Terminal

  3. Create Card Present Processing

  4. Card-present Sale / Auth

Notes

  • Required credential fields vary by processor; First Data uses terminal_id/TTP_id/group_id, while Cybersource uses api_key/password.

  • Store credentials securely and never expose them client-side.

Common Mistakes

  • Omitting type (must be CP).

  • Sending Cybersource without api_key/password, or First Data without its identifiers.

Body Params
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain