AI agent? Read this page as Markdown at /payment/payment/Retrieve_a_payment.md — append .md to any docs URL, or start from /llms.txt.

Retrieve a payment

GET/payment/{connection_id}/payment/{id}

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Payment

Returns

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumber
contact_idstring
(reference to AccountingContact)
payment_methodstring
type enum
Valid values:
"INVOICE"
"BILL"
currencystring
notesstring
invoice_idstring
(reference to AccountingInvoice)
bill_idstring
references AccountingBill
link_idstring
account_idstring
(reference to AccountingAccount)
referencestring
organization_idstring
reference to an AccountingOrganization
allocations array
What this payment was applied to (invoices, bills, credit memos, etc.). Replaces separate invoice/bill payment endpoints.
status enum
Valid values:
"SUCCEEDED"
"PENDING"
"AUTHORIZED"
"FAILED"
"CANCELED"
salesorder_idstring
reference to an AccountingSalesorder, e.g. the POS order this payment settled
tender_type enum
Valid values:
"CARD"
"CASH"
"GIFT_CARD"
"BANK_TRANSFER"
"WALLET"
normalized tender category; the provider's original label stays in payment_method
tip_amountnumber
fee_amountnumber
processing/processor fee
location_idstring
store/site where the payment was taken (commerce_location)
device_idstring
POS terminal/register/device (hr device)
card_brandstring
card_last4string
const options = {
  method: 'GET',
  url: 'https://api.unified.to/payment/5de520f96e439b002043d8dc/payment/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?