payment
payment

Update a payment

put/payment/{connection_id}/payment/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/payment/{connection_id}/payment/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Payment

Query parameters

fieldsstring[]

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

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
contact_idstring

(reference to AccountingContact)

payment_methodstring
type'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

status'SUCCEEDED' | 'PENDING' | 'AUTHORIZED' | 'FAILED' | 'CANCELED'
salesorder_idstring

reference to an AccountingSalesorder, e.g. the POS order this payment settled

tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'

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
paid_atstring date-time

Date and time the payment was made (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

exchange_ratenumber

Exchange rate to the base/home currency at the payment date

category_idsstring[]

dimension refs -> AccountingCategory

net_amountnumber

total_amount minus fee_amount

rawunknown

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

total_amountnumber
contact_idstring

(reference to AccountingContact)

payment_methodstring
type'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

status'SUCCEEDED' | 'PENDING' | 'AUTHORIZED' | 'FAILED' | 'CANCELED'
salesorder_idstring

reference to an AccountingSalesorder, e.g. the POS order this payment settled

tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'

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
paid_atstring date-time

Date and time the payment was made (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

exchange_ratenumber

Exchange rate to the base/home currency at the payment date

category_idsstring[]

dimension refs -> AccountingCategory

net_amountnumber

total_amount minus fee_amount

rawunknown

Changes

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