payment
link

List all links

Changed on
get/payment/{connection_id}/link

Request

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

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

payment_idstring

The payment ID to filter by (reference to PaymentPayment)

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

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)

is_activeboolean
currencystring
amountnumber
payment_idstring

(reference to PaymentPayment)

contact_idstring

ID of the AccountingContact (reference to AccountingContact)

urlstring

the payment link

descriptionstring
is_chargeable_nowboolean
success_urlstring
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status