PIpismo
Processing codes

Get processing code

Get details about a specific processing code.

get/orgs-operation/v1/processing-codes/{processingCode}

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/orgs-operation/v1/processing-codes/{processingCode}
  • Auth
    HTTP bearer

Path parameters

processingCodestring required
Example:PC0000

Processing code ID

Query parameters

languagestring
Example:en-US

Description language requested. If this field is not present or the language is not in the translation list, the default description (root description) is returned.

For example, the code for English (United States) is en-US. The prefix, en, is a language code following the ISO 639-1 standard. The suffix, US, is a country code following the ISO 3166-1 Alpha-2 standard.

Response

Successful response

processing_codestring

A processing code identifies a financial operation on the Pismo platform. Processing codes need to be mapped to transaction type codes to create a transaction flow.

A custom processing code is created with a PENDING status . Initially, its use is not allowed in authorizations. Once the transaction flow for a custom processing code is completely configured, its status changes to SUCCESS and it is ready for use.

For more information, refer to Processing codes

org_operation_idinteger

Org operation ID

balance_impact1 | 0 | -1

Balance impact associated with processing code:

  • 1 - Credit
  • 0 - No impact. Zero balance operations have no impact. Zero balance customers are responsible for settling accounts and generating transactions.
  • -1 - Debit
descriptionstring

Processing code description

standardboolean

Is this a standard processing code? A standard processing code, as opposed to a custom one, is one that is pre-defined for every organization on the Pismo platform.

For more information, refer to Standard processing codes.

reversal_processing_codestring

Reversal processing code. Processing code for cancellation. Used in transactions and accounting flow to post the correct entries related to cancellation.

Every AUTHORIZATION processing code is REQUIRED to have a reversal and a partial reversal processing code. If a partial code isn't provided, a default one is assigned based on balance_impact.

The reversal processing code can either currently exist or not. If it exists, its balance_impact must be the opposite of the main processing code and its type must be REVERSAL.

For more information, refer to default reversal processing codes.

partial_reversal_processing_codestring

Partial reversal processing code. Processing code for partial reversal cancellation. Used in transactions and accounting flow to post the correct entries related to partial cancellation.

Every AUTHORIZATION processing code is REQUIRED to have a reversal and a partial reversal processing code. If a partial code isn't provided, a default one is assigned based on balance_impact.

For more information, refer to default reversal processing codes.

status'SUCCESS' | 'PENDING'

Processing code status:

  • PENDING - Missing required configurations. A custom processing code is initially created with a PENDING status and its use is not allowed in authorizations. Once the transaction flow for a custom processing code is completely configured, its status changes to SUCCESS and it is ready for use. All standard processing codes have a SUCCESS status.

  • SUCCESS - Required configurations done

tagsstring[]

Processing code tags. These tags apply ONLY to AUTHORIZATION type processing codes. You cannot add tags to reverse processing codes as they may be associated with more than one authorization processing code.

Example response

{
  "balance_impact": 1,
  "standard": true,
  "reversal_processing_code": "578739",
  "partial_reversal_processing_code": "578739",
  "status": "SUCCESS",
  "tags": [
    "INDIA"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.