Payments

Field

Description

id string

Unique identifier for the payment.

amount_cents
integer

Amount paid.

currency
string

Currency to be used for invoice payment. The accepted value is "USD"

originating_counterparty_id
string

The ID of one of your organization's internal counterparty (Buyer) that will send the payment.

receiving_counterparty_id
string

The ID of your external counterparty (Supplier) that will receive the invoice payment.

payment_method
string

Method used for the payment. Available options are: Check, ACH, Card and Wire

delivery_method
string

Delivery method used for the payment. Mail , Email, Phone, or Null

tracking_id
string

Used to reference this payment when communicating with Finexio's Customer Support and Payment Operations teams.

instrument_number
string

Check - Check number
ACH - Trace number from the bank
Wire - N/A
Card - Last 4 digits of the card

status
string

Current payment status:

  • *pending**: Payment is being prepared for payment.
  • *in-progress**: Payment for this invoice is in-progress.
  • *settled**: Payment for this invoice has been resolved.
  • *failed**: An exception has occurred during payment processing.
  • *canceled**: Funding for payment has an unrecoverable failure, or a pre- funding stop was performed.

events
object

Status and events of the payment through its lifecycle.

invoices
object

List of invoices associated with this payment.

created
timestamp

Date the Payment was created.

updated
timestamp

Date the Payment was last updated.

funding_drawdown_request_id
string

reissue_payment_method
string

reconciliation_id
string

A string to identify the invoice in your accounting system. Max-length = 50

refund_user
string

Name of the user who initiated the refund.

refund_timestamp
timestamp

Timestamp of when the refund was initiated.

refund_reason
string

Reason for the refund selected from a predefined list.

refund_comment
string

Additional comments provided by the user at the time of refund.

refund_ticket_number
string

Optional field for tracking ticket numbers associated with the refund.

reissue_user
string

Name of the user who initiated the reissue.

reissue_timestamp
timestamp

Timestamp of when the reissue was initiated.

reissue_reason
string

Reason for the reissue selected from a predefined list.

reissue_comment
string

Additional comments provided by the user at the time of reissue.

reissue_ticket_number
string

Optional field for tracking ticket numbers associated with the reissue.

finexio_express
boolean

Indicates if the ACH payment was sent using Finexio Express.