Sign in
OpenAPI 3.0.02026-08-208311,3333.4 MB

fecb148873a5

payment
payment

Update a payment

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

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
updated_atstring date-time
total_amountnumber
contact_idstring
payment_methodstring
type'INVOICE' | 'BILL'
currencystring
notesstring
invoice_idstring
bill_idstring
link_idstring
account_idstring
referencestring
organization_idstring
status'SUCCEEDED' | 'PENDING' | 'AUTHORIZED' | 'FAILED' | 'CANCELED'
salesorder_idstring
tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'
tip_amountnumber
fee_amountnumber
location_idstring
device_idstring
card_brandstring
card_last4string
rawobject

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
total_amountnumber
contact_idstring
payment_methodstring
type'INVOICE' | 'BILL'
currencystring
notesstring
invoice_idstring
bill_idstring
link_idstring
account_idstring
referencestring
organization_idstring
status'SUCCEEDED' | 'PENDING' | 'AUTHORIZED' | 'FAILED' | 'CANCELED'
salesorder_idstring
tender_type'CARD' | 'CASH' | 'GIFT_CARD' | 'BANK_TRANSFER' | 'WALLET' | 'CHECK' | 'STORE_CREDIT' | 'BUY_NOW_PAY_LATER' | 'EXTERNAL' | 'OTHER'
tip_amountnumber
fee_amountnumber
location_idstring
device_idstring
card_brandstring
card_last4string
rawobject