Transaction Objects

Create Transaction

POST /(company_code)/v2/transaction

Create new Transaction

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Request JSON Object:
 
  • entry_code (string/null) – (Optional) Entry code for transaction. Entry mnemocode is accepted for all users. If user role is PARTNER, entry external ID is checked before mnemocode.
  • profile_code (string/null) – (Optional) Profile code for transaction. Profile mnemocode is accepted for all users. If user role is PARTNER, profile external ID is checked before mnemocode.
  • transaction_class (string) – Name of transaction class for new transaction
  • transaction_date (string/null) – (Optional) Date for new transaction, ISO-formatted: YYYY-MM-DD. If omitted, current date is used.
  • transaction_currency (string) – Currency code for new transaction
  • transaction_amount (string) – Amount (in one-hundredths of currency) for new transaction
  • attributes (array) – (Optional) Data objects for entry attributes (see below)
  • details (string/null) – (Optional) Text of transaction details
Response JSON Object:
 
  • status (string) – success or error
  • data (object) – Data object of created transaction
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Request attribute data fields

Each object in attributes request array has the following fields:

Field name Type Description
seq integer Attribute sequential number, 1 to 20
value string New attribute value

Sequential numbers must be the same as in attribute objects returned by API in transaction data.

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed

See Error Codes for details.