Processor Profile: gets a single processor profile by id.
GET
/api/merchants/{id}/processor-profiles/{profileId}
deprecated
Requires: Merchants.Merchants, merchant scope.
Example: `GET /api/merchants/{id}/processor-profiles/{profileId}`.
Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
id
required |
path | string (uuid) | The merchant id. |
profileId
required |
path | string (uuid) | The processor profile id. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
Body: ProcessorProfileDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
processorProfileId
required |
string (uuid) | Gets or sets the unique identifier of this processor profile. |
merchantId
required |
string (uuid) | Corresponding merchant id |
paymentTypes
required |
array of ProcessorProfilePaymentType | Payment types turned on for this profile. nullable |
isActive
required |
boolean | Shows if the current profile is active or not. |
enabledTenders
required |
all of TenderEnableFlags | Per-tender enable flags applied by the capability cascade at the processor-account layer. `null` indicates "all disabled" for legacy profiles that have never opted in to a non-credit tender. |
merchantProcessorConfiguration
required |
all of MerchantProcessorConfigurationDto | Corresponding configuration holding the details of the processor. |
merchantConcurrencyStamp
required |
string | The merchant's concurrency stamp after the write that returned this profile, or `null` on a read. nullable |
datawireRegistration
required |
all of ProcessorProfileDatawireRegistrationDto | What automatic Datawire registration did during the write that returned this profile. Absent when it did not run (any non-Fiserv profile, a Fiserv profile that already carries a Datawire ID, and every read). |
webhookRegistrationToken
required |
string | The token in this profile's webhook registration URL, for a processor whose provider sends webhooks to a URL registered per merchant. Absent for every other processor. nullable |
This response has no documented body fields.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
400 Bad Request
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
404 Not Found
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.