Skip to main content

Paymentmadetransactioninput

Represents the request payload for creating a transaction of type PAYMENT_MADE

amountnumberrequired

The amount of the payment

bookingDatestring<date-time>

The booking date of the payment made transaction (as Organization Time)

Example: 2016-09-06T13:37:50+03:00
externalIdstring

The external id of the payment made transaction, customizable, unique

notesstring

Notes about the payment made transaction. The notes can have at most 255 characters in length.

originalCurrencyCodestring

The currency code for the payment made transaction

transactionDetails object

Contains the details about transaction including fields like transaction channel key and channel ID

transactionChannelIdstring

The id of the transaction channel associated with the transaction details input.

transactionChannelKeystring

The encoded key of the transaction channel associated with the transaction details input.

valueDatestring<date-time>

The entry date of the payment made transaction (as Organization Time)

Example: 2016-09-06T13:37:50+03:00
_Example_Custom_Fields _Example_Custom_Fields

An example of some custom field values. For more information on working with custom fields using the API, see Using Custom Fields.

Example_Checkbox_Fieldstring

A field that will appear as a checkbox in the UI. In the API, the value will be TRUE or FALSE as a string. The value must be provided as a string, not a boolean.

Possible values: [TRUE, FALSE]

Example_Free_Text_Field

A field that can contain a string of text. Pay attention to proper JSON escaping if providing values for such fields via API.

Example_Number_Fieldstring<number>

A field supporting numbers only. Please note: the value is to be provided as a string.

Example_Select_Fieldobject

A field that supports enumerated values. Requests will fail if the value provided for such a field is not one of the supported IDs or values.

Example_Date_Fieldstring<date>

A date field takes a date in YYYY-MM-DD format.

Example: 2018-12-14
Example_Datetime_Fieldstring<datetime>

A date field takes a timestamp in YYYY-MM-DDThh:mm:ss.SSS+hh:mm format.

Example: 2018-12-14T15:30:00.000+01:30
Example_UserLink_Fieldstring

A user link field takes the encodedKey of a Mambu user.

Example_GroupLink_Fieldstring

A group link field takes the encodedKey of a group.

Example_ClientLink_Fieldstring

A client link field stores the encodedKey of a client.

Paymentmadetransactioninput
{
  "amount": 0,
  "bookingDate": "2016-09-06T13:37:50+03:00",
  "externalId": "string",
  "notes": "string",
  "originalCurrencyCode": "string",
  "transactionDetails": {
    "transactionChannelId": "string",
    "transactionChannelKey": "string"
  },
  "valueDate": "2016-09-06T13:37:50+03:00",
  "_Example_Custom_Fields": {
    "Example_Checkbox_Field": "TRUE",
    "Example_Free_Text_Field": "A free text field up to 255 characters in length",
    "Example_Number_Field": "46290",
    "Example_Select_Field": {
      "example_option_id": "873023434",
      "example_option_value": "option 5"
    },
    "Example_Date_Field": "2018-12-14",
    "Example_Datetime_Field": "2020-12-20T15:30:00.000+01:00",
    "Example_UserLink_Field": "8a19cda5778bea6c01778c17fdff027c",
    "Example_GroupLink_Field": "8a19d63c84a36c7f0184a4f33ba85235",
    "Example_ClientLink_Field": "8a19cdac84a3a6c01778a4f33baf027c"
  }
}