TRtrueaccord
Payments

Add Payments to Account

Changed on

Account payments - payments provide feedback to the Retain system to make Heartbeat smarter. Please provide all of the unique payments for accounts placed, meaning only send one payment record for each payment received. Also, only send payments received during the time the account was placed with Retain. It is important that the Category Code is provided correctly, and that required fields are present. Please note, that for multi account/record payment requests, if one or more of the accounts cannot be found in our system (e.g. an incorrect accountNumber or accountNamespace is provided), while other accounts in the request can be found, the validly identified accounts will have their payments recorded and the response will indicate the accounts that were not properly identified in the request. A maximum of 175 accounts/records can be included in a single request.

post/inbound/v1/payments

Request

Request body

accountNumberstring required

Account number of account for which to record the payment.

accountNamespacestring required

accountNamespace that the account was originally placed with.

paymentDescriptionstring required

Free-form description of payment.

paymentAmountinteger required

Amount of payment made. Amount is in cents.

transactionDatestring required

Date the payment occurred (mm/dd/yyyy).

categoryCode'DEBIT' | 'PAYMENT' | 'OTHER' | 'OTHER CREDIT' required

Type of transaction (Debit, Payment, Other Credit)

Response

successful operation

ClientIdstring required

Client Id

Statusstring required

Response status (SUCCESS)

Messagestring required

Message description

ProcessedRecordsinteger required

Number or records processed

Changes

  • 8a19069a1bb6Revision changes
    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • warning

      removed the request property /

    • info

      added the new OTHER CREDIT enum value to the request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value Inbound process ends without errors was added for the status

    • info

      the response's property default value SUCCESS was added for the status

    • info

      removed the ERROR enum value from the response property for the response status

    • info

      removed the FAILURE enum value from the response property for the response status

    • info

      removed the SUCCESS enum value from the response property for the response status

  • 2d776a692387Revision changes
    • info

      endpoint added