Read

GET {{baseUrl}}/crm/v3/objects/commerce_payments/:commercePaymentId?properties=<string>&properties=<string>&propertiesWithHistory=<string>&propertiesWithHistory=<string>&associations=<string>&associations=<string>&archived=false&idProperty=<string>

Read a payment identified by its ID. Include an optional properties query parameter to control the properties that are returned.

Request Params

KeyDatatypeRequiredDescription
propertiesstringA comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested payment, they will be ignored.
propertiesstringA comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested payment, they will be ignored.
propertiesWithHistorystringA comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested payment, they will be ignored.
propertiesWithHistorystringA comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested payment, they will be ignored.
associationsstringA comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
associationsstringA comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
archivedbooleanWhether to return only results that have been archived.
idPropertystringThe name of a property whose values are unique for this object type.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;properties&quot;:{&quot;commodo_2&quot;:&quot;\u003cstring\u003e&quot;},&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;associations&quot;:{&quot;esse8&quot;:{&quot;results&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;paging&quot;:{&quot;next&quot;:{&quot;after&quot;:&quot;\u003cstring\u003e&quot;,&quot;link&quot;:&quot;\u003cstring\u003e&quot;},&quot;prev&quot;:{&quot;before&quot;:&quot;\u003cstring\u003e&quot;,&quot;link&quot;:&quot;\u003cstring\u003e&quot;}}},&quot;eiusmod_3&quot;:{&quot;results&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;}],&quot;paging&quot;:{&quot;next&quot;:{&quot;after&quot;:&quot;\u003cstring\u003e&quot;,&quot;link&quot;:&quot;\u003cstring\u003e&quot;},&quot;prev&quot;:{&quot;before&quot;:&quot;\u003cstring\u003e&quot;,&quot;link&quot;:&quot;\u003cstring\u003e&quot;}}}},&quot;archived&quot;:&quot;\u003cboolean\u003e&quot;,&quot;archivedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;propertiesWithHistory&quot;:{&quot;dolor_fe&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;Ut_c21&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}],&quot;sed82&quot;:[{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;},{&quot;sourceType&quot;:&quot;\u003cstring\u003e&quot;,&quot;timestamp&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceId&quot;:&quot;\u003cstring\u003e&quot;,&quot;sourceLabel&quot;:&quot;\u003cstring\u003e&quot;,&quot;updatedByUserId&quot;:&quot;\u003cinteger\u003e&quot;}]}}