---
title: "Report a payment"
method: POST
path: "/customers/{customerId}/debts/{debtId}/payments/"
tags: ["Payments"]
---

# Report a payment

`POST /customers/{customerId}/debts/{debtId}/payments/`

## Request

- Base URL: `https://api.trueaccord.com/api/v1`
- URL: `https://api.trueaccord.com/api/v1/customers/{customerId}/debts/{debtId}/payments/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/trueaccord/apis/trueaccord-api/docs/customers/:customerId/debts/:debtId/payments/post.ts> (a function with typed inputs; its response is checked against the schema)

Update TrueAccord system with infomration about customer payment. 

**NOTE:** For balance adjustments, use the following route instead of this one: `/customers/{customerId}/debts/{debtId}/totalToCollectBalance`

## Request body

- PaymentRequest
  - `amount` MonetaryAmount
    - `amount` integer
    - `currency` string
  - `payee` 'CREDITOR' | 'TRUEACCORD': * `CREDITOR`: Use when payment made directly to creditor. * `TRUEACCORD`: Use when payment made to TrueAccord.
  - `transactionReference` string: Used to associate payment to transaction on creditor's internal system.
  - `transactionType` 'PAYMENT' | 'RETURNED_PAYMENT' | 'REFUND': * `PAYMENT`: Use for standard payment. Deducts the debt balance. Amount must be positive. * `RETURNED_PAYMENT`: Use for payment that failed after it was declared successful. Typically used when ACH payments return or when creditor refunds customer. The payment increases the debt balance. Must be negative. * `REFUND`: Use for payment refunded after it was made. Increases debt's balance. Must be negative.
  - `note` string: Note about the payment.
  - `paymentTimestamp` integer: Optional. Time payment was created in milliseconds since Jan 1st, 1970 UTC.. If not directly provided by user during payment creation, then the response will provide the same value as the `meta.timeCreated`.

## Response `201`

Same as request object with a `meta` field and `paymentTimestamp` if `paymentTimestamp` wasn't included in request.

- Payment
  - `meta` object
    - `id` string
    - `timeCreated` integer: Milliseconds since Jan 1st, 1970 UTC.
  - `amount` MonetaryAmount
    - `amount` integer
    - `currency` string
  - `payee` 'CREDITOR' | 'TRUEACCORD': * `CREDITOR`: Use when payment made directly to creditor. * `TRUEACCORD`: Use when payment made to TrueAccord.
  - `transactionReference` string: Used to associate payment to transaction on creditor's internal system.
  - `transactionType` 'PAYMENT' | 'RETURNED_PAYMENT' | 'REFUND': * `PAYMENT`: Use for standard payment. Deducts the debt balance. Amount must be positive. * `RETURNED_PAYMENT`: Use for payment that failed after it was declared successful. Typically used when ACH payments return or when creditor refunds customer. The payment increases the debt balance. Must be negative. * `REFUND`: Use for payment refunded after it was made. Increases debt's balance. Must be negative.
  - `note` string: Note about the payment.
  - `paymentTimestamp` integer: Time payment was created in milliseconds since Jan 1st, 1970 UTC. If not directly provided by user during payment creation, then same as `meta.timeCreated`.

---

[API](https://skmtc.dev/trueaccord/apis/trueaccord-api.md) - [All operations](https://skmtc.dev/trueaccord/apis/trueaccord-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trueaccord/apis/trueaccord-api/revisions/93d3c0ce897d?raw)