v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Transaction flows

Update transaction flow

Update key or custom_key for the relation between processing code and transaction type ID. You can only use this endpoint to update a transaction flow that is already created.

patch/v1/transaction-flow/processing-code/{processingCode}/transaction-type/{transactionTypeId}

Path parameters

processingCodestring required

Processing code for an existing transaction flow, given the transaction type ID.

transactionTypeIdinteger required

Transaction type ID related to the processing code.

Request body

key'PRINCIPAL' | 'INSTALLMENT' | 'CONTRACT' | 'OTHER' required

Sets the relation key that links transaction type and processing code.

PRINCIPAL uses principal amount.
INSTALLMENT uses installment amount.
CONTRACT uses contract amount.
OTHER uses any custom amount, such as fees, taxes, or other charges. When the key is OTHER, you must define the custom_key value.

custom_keystring

Sets a customized relation between transaction type and processing code. This field is tied to the type or ID of a custom fee model that configures fees, taxes, or other charges. REQUIRED if the key is OTHER.

Example request

{
  "key": "OTHER",
  "custom_key": "national_rate"
}

Response

transaction_type_idinteger required

Transaction type ID. Certain IDs are reserved by the platform and cannot be used.

processing_codestring required

Processing code that issues the transaction type.

key'PRINCIPAL' | 'INSTALLMENT' | 'CONTRACT' | 'OTHER' required

The relation key that links transaction type and processing code.

PRINCIPAL uses principal amount.
INSTALLMENT uses installment amount.
CONTRACT uses contract amount.
OTHER uses any custom amount, such as fees, taxes, or other charges. When the key is OTHER, you must define the custom_key value.

custom_keystring

The customized relation between transaction type and processing code. This field is tied to the type or ID of a custom fee model that configures fees, taxes, or other charges. REQUIRED if the key is OTHER.

Example response

{
  "transaction_type_id": 7001,
  "processing_code": "00AB11",
  "key": "OTHER",
  "custom_key": "national_rate"
}