TRtrueaccord
Payments

Report a payment

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

post/customers/{customerId}/debts/{debtId}/payments/

Request

Request body

payee'CREDITOR' | 'TRUEACCORD'
  • CREDITOR: Use when payment made directly to creditor.
  • TRUEACCORD: Use when payment made to TrueAccord.
transactionReferencestring

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.
notestring

Note about the payment.

paymentTimestampinteger

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.

Example request

{
  "amount": {
    "amount": 30000,
    "currency": "USD"
  },
  "payee": "CREDITOR",
  "transactionType": "PAYMENT",
  "note": "Paid directly via CC"
}

Response

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

payee'CREDITOR' | 'TRUEACCORD'
  • CREDITOR: Use when payment made directly to creditor.
  • TRUEACCORD: Use when payment made to TrueAccord.
transactionReferencestring

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.
notestring

Note about the payment.

paymentTimestampinteger

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.

Example response

{
  "meta": {
    "id": "11111111111111111111111111111111"
  },
  "amount": {
    "amount": 30000,
    "currency": "USD"
  },
  "payee": "CREDITOR",
  "transactionType": "PAYMENT",
  "note": "Paid directly via CC"
}

Changes

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