Get Payment Detail

get https://api.finexio-stage.com/v2/payments/{key}/

Get Details Of A Payment Specified By Key

Example Response

See Payment Schema for more details.

{
    "id": "be5f7fab-285c-42fe-b3a3-12b550e53d5c",
    "amount_cents": 333,
    "currency": "USD",
    "originating_counterparty_id": "041bbd12-7ee0-4e33-b8bc-1bd7736a58c3",
    "receiving_counterparty_id": "68732352-1b68-4072-9ca1-d3379e829f59",
    "payment_method": "wire",
    "reissue_payment_method": null,
    "delivery_method": "email",
    "reconciliation_id": null,
    "tracking_id": "RC00R00X00I21A40B",
    "instrument_number": null,
    "status": "in-progress",
    "events": [
        {
            "timestamp": "2024-08-07T13:44:53.590000",
            "event_code": "PU00",
            "description": "Invoices Created",
            "amount_cents": 333,
            "stage": "processing",
            "method": null,
            "event_name": "requested",
            "status": "in-progress"
        },
        {
            "timestamp": "2024-08-07T13:44:55.055000",
            "event_code": "PU12",
            "description": "Payments Received By Processor",
            "amount_cents": 333,
            "stage": "processing",
            "method": null,
            "event_name": "confirmed",
            "status": "in-progress"
        },
        {
            "timestamp": "2024-08-07T13:44:55.773000",
            "event_code": "FA00",
            "description": "Request ACH Funding",
            "amount_cents": 333,
            "stage": "funding",
            "method": "ach",
            "event_name": "requested",
            "status": "in-progress"
        }
    ],
    "invoices": [
        {
            "id": "b3e77c89-aedc-4aa0-848f-1b4014b27087",
            "invoice_number": "202402ss1426",
            "payment_amount_cents": 333,
            "metadata": {
                "someMetadata": "value"
            },
            "public_account_number": null,
            "reconciliation_id": null,
            "payment_group_id": ""
        }
    ],
    "adjustments": [],
    "created": "2024-08-07T13:44:53.575000",
    "updated": "2024-08-07T13:44:55.903000",
    "funding_drawdown_request_id": "U824-012-419K",
    "refund_user": null,
    "refund_timestamp": null,
    "refund_reason": null,
    "refund_comment": null,
    "refund_ticket_number": null,
    "reissue_user": null,
    "reissue_timestamp": null,
    "reissue_reason": null,
    "reissue_comment": null,
    "reissue_ticket_number": null
}

Responses

Response body

object

string

created

date-time

updated

date-time

amount_cents

integer

currency

integer

originating_counterparty_id

uuid

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

receiving_counterparty_id

uuid

The ID of one of your external counterparties (Supplier) that will receive payment.

payment_method

string

check ach card wire

delivery_method

string

email mail phone web

tracking_id

string

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

instrument_number

string

status

string

Current payment status

pending in-progress settled cancelled

events

array of objects

events

object

timestamp

date-time

event_code

string

description

string

amount_cents

string

stage

string

method

string

event_name

string

status

string

invoices

array of objects

List of invoices associated with this payment.

invoices

object

string

invoice_number

string

payment_amount_cents

integer

metadata

object

Additional private data represented as key-value pairs.

Has additional fields

reconciliation_id

string

A string to identify the invoice in your accounting system.

payment_group_id

string

Optional value that will be used to group invoices into payments. When specified, only invoices with the same value will be included in a single payment.

public_account_number

string

adjustments

object

Has additional fields

funding_drawdown_request_id

string

reissue_payment_method

string

check ach card wire

reconciliation_id

string

length ≤ 50

A string to identify the invoice in your accounting system.

refund_user

string

Name of the user who initiated the refund.

refund_timestamp

date-time

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

date-time

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.

Example Response

200Success

404Not Found