Qodex.ai

Get Payment

GET {{baseUrl}}/pos/payments/:id?raw=false&fields=id,updated_at

Get Payment

Request Params

KeyDatatypeRequiredDescription
rawbooleanInclude raw response. Mostly used for debugging purposes
fieldsstringThe 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

HEADERS

KeyDatatypeRequiredDescription
x-apideck-consumer-idstring(Required) ID of the consumer which you want to get or push data from
x-apideck-app-idstring(Required) The ID of your Unify application
x-apideck-service-idstringProvide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Acceptstring

RESPONSES

status: OK

{&quot;status_code&quot;:200,&quot;status&quot;:&quot;OK&quot;,&quot;service&quot;:&quot;square&quot;,&quot;resource&quot;:&quot;PosPayments&quot;,&quot;operation&quot;:&quot;one&quot;,&quot;data&quot;:{&quot;source_id&quot;:&quot;12345&quot;,&quot;customer_id&quot;:&quot;12345&quot;,&quot;amount&quot;:27.5,&quot;currency&quot;:&quot;USD&quot;,&quot;order_id&quot;:&quot;12345&quot;,&quot;tender_id&quot;:&quot;12345&quot;,&quot;id&quot;:&quot;12345&quot;,&quot;merchant_id&quot;:&quot;12345&quot;,&quot;employee_id&quot;:&quot;12345&quot;,&quot;location_id&quot;:&quot;12345&quot;,&quot;device_id&quot;:&quot;12345&quot;,&quot;external_payment_id&quot;:&quot;12345&quot;,&quot;idempotency_key&quot;:&quot;random_string&quot;,&quot;tip&quot;:7,&quot;tax&quot;:20,&quot;total&quot;:37.5,&quot;app_fee&quot;:3,&quot;change_back_cash_amount&quot;:20,&quot;approved&quot;:37.5,&quot;refunded&quot;:37.5,&quot;processing_fees&quot;:[{&quot;amount&quot;:1.05,&quot;effective_at&quot;:&quot;2020-09-30T07:43:32.000Z&quot;,&quot;processing_type&quot;:&quot;initial&quot;}],&quot;source&quot;:&quot;external&quot;,&quot;status&quot;:&quot;approved&quot;,&quot;cash&quot;:{&quot;amount&quot;:{&quot;description&quot;:&quot;The amount of cash given by the customer.&quot;},&quot;charge_back_amount&quot;:{&quot;description&quot;:&quot;The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields.&quot;}},&quot;card_details&quot;:{&quot;card&quot;:{&quot;id&quot;:&quot;12345&quot;,&quot;bin&quot;:&quot;41111&quot;,&quot;card_brand&quot;:&quot;discover-diners&quot;,&quot;card_type&quot;:&quot;credit&quot;,&quot;prepaid_type&quot;:&quot;prepaid&quot;,&quot;cardholder_name&quot;:&quot;John Doe&quot;,&quot;customer_id&quot;:&quot;12345&quot;,&quot;merchant_id&quot;:&quot;12345&quot;,&quot;exp_month&quot;:1,&quot;exp_year&quot;:2022,&quot;fingerprint&quot;:&quot; Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.&quot;,&quot;last_4&quot;:&quot;The last 4 digits of the card number.&quot;,&quot;enabled&quot;:true,&quot;billing_address&quot;:{&quot;id&quot;:&quot;123&quot;,&quot;type&quot;:&quot;primary&quot;,&quot;string&quot;:&quot;25 Spring Street, Blackburn, VIC 3130&quot;,&quot;name&quot;:&quot;HQ US&quot;,&quot;line1&quot;:&quot;Main street&quot;,&quot;line2&quot;:&quot;apt #&quot;,&quot;line3&quot;:&quot;Suite #&quot;,&quot;line4&quot;:&quot;delivery instructions&quot;,&quot;street_number&quot;:&quot;25&quot;,&quot;city&quot;:&quot;San Francisco&quot;,&quot;state&quot;:&quot;CA&quot;,&quot;postal_code&quot;:&quot;94104&quot;,&quot;country&quot;:&quot;US&quot;,&quot;latitude&quot;:&quot;40.759211&quot;,&quot;longitude&quot;:&quot;-73.984638&quot;,&quot;county&quot;:&quot;Santa Clara&quot;,&quot;contact_name&quot;:&quot;Elon Musk&quot;,&quot;salutation&quot;:&quot;Mr&quot;,&quot;phone_number&quot;:&quot;111-111-1111&quot;,&quot;fax&quot;:&quot;122-111-1111&quot;,&quot;email&quot;:&quot;elon@musk.com&quot;,&quot;website&quot;:&quot;https://elonmusk.com&quot;,&quot;notes&quot;:&quot;Address notes or delivery instructions.&quot;,&quot;row_version&quot;:&quot;1-12345&quot;},&quot;reference_id&quot;:&quot;card-001&quot;,&quot;version&quot;:&quot;230320320320&quot;}},&quot;bank_account&quot;:{&quot;bank_name&quot;:&quot;sed magn&quot;,&quot;transfer_type&quot;:&quot;elit dolore&quot;,&quot;account_ownership_type&quot;:&quot;qui&quot;,&quot;fingerprint&quot;:&quot;et Lorem eu commodo&quot;,&quot;country&quot;:&quot;US&quot;,&quot;statement_description&quot;:&quot;tempor&quot;,&quot;ach_details&quot;:{&quot;routing_number&quot;:&quot;proident sunt&quot;,&quot;account_number_suffix&quot;:&quot;in&quot;,&quot;account_type&quot;:&quot;nulla consectetur eiusmod in la&quot;}},&quot;wallet&quot;:{&quot;status&quot;:&quot;captured&quot;},&quot;external_details&quot;:{&quot;type&quot;:&quot;other&quot;,&quot;source&quot;:&quot;consequat dolore eu&quot;,&quot;source_id&quot;:&quot;quis ullamco nulla&quot;,&quot;source_fee_amount&quot;:2.5},&quot;service_charges&quot;:[{&quot;id&quot;:&quot;12345&quot;,&quot;name&quot;:&quot;Charge for delivery&quot;,&quot;amount&quot;:27500,&quot;percentage&quot;:12.5,&quot;currency&quot;:&quot;USD&quot;,&quot;active&quot;:true,&quot;type&quot;:&quot;custom&quot;},{&quot;id&quot;:&quot;12345&quot;,&quot;name&quot;:&quot;Charge for delivery&quot;,&quot;amount&quot;:27500,&quot;percentage&quot;:12.5,&quot;currency&quot;:&quot;USD&quot;,&quot;active&quot;:true,&quot;type&quot;:&quot;custom&quot;}],&quot;custom_mappings&quot;:{},&quot;updated_by&quot;:&quot;12345&quot;,&quot;created_by&quot;:&quot;12345&quot;,&quot;updated_at&quot;:&quot;2020-09-30T07:43:32.000Z&quot;,&quot;created_at&quot;:&quot;2020-09-30T07:43:32.000Z&quot;}}