Sign in
Transaction flows

Create transaction flow

Creates a configuration linking a transaction type with a processing code.

See Processing codes and transaction types and Payments configurations for information on processing codes and transaction types, how to create them, and map them to each other.

post/v1/transaction-flow

Request body

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 request

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

Response

Created

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"
}

Changes

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