List Payments
GET {{baseUrl}}/pos/payments?raw=false&cursor=tempor consequat&limit=1&fields=id,updated_at
List Payments
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes | |
cursor | string | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | |
limit | number | Number of results to return. Minimum 1, Maximum 200, Default 20 | |
fields | string | The '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
| Key | Datatype | Required | Description |
|---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","service":"square","resource":"PosPayments","operation":"all","data":[{"source_id":"12345","customer_id":"12345","amount":27.5,"currency":"USD","order_id":"12345","tender_id":"12345","id":"12345","merchant_id":"12345","employee_id":"12345","location_id":"12345","device_id":"12345","external_payment_id":"12345","idempotency_key":"random_string","tip":7,"tax":20,"total":37.5,"app_fee":3,"change_back_cash_amount":20,"approved":37.5,"refunded":37.5,"processing_fees":[{"amount":1.05,"effective_at":"2020-09-30T07:43:32.000Z","processing_type":"initial"}],"source":"external","status":"approved","cash":{"amount":{"description":"The amount of cash given by the customer."},"charge_back_amount":{"description":"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."}},"card_details":{"card":{"id":"12345","bin":"41111","card_brand":"mastercard","card_type":"credit","prepaid_type":"prepaid","cardholder_name":"John Doe","customer_id":"12345","merchant_id":"12345","exp_month":1,"exp_year":2022,"fingerprint":" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.","last_4":"The last 4 digits of the card number.","enabled":true,"billing_address":{"id":"123","type":"primary","string":"25 Spring Street, Blackburn, VIC 3130","name":"HQ US","line1":"Main street","line2":"apt #","line3":"Suite #","line4":"delivery instructions","street_number":"25","city":"San Francisco","state":"CA","postal_code":"94104","country":"US","latitude":"40.759211","longitude":"-73.984638","county":"Santa Clara","contact_name":"Elon Musk","salutation":"Mr","phone_number":"111-111-1111","fax":"122-111-1111","email":"elon@musk.com","website":"https://elonmusk.com","notes":"Address notes or delivery instructions.","row_version":"1-12345"},"reference_id":"card-001","version":"230320320320"}},"bank_account":{"bank_name":"e","transfer_type":"in reprehenderit sunt labore","account_ownership_type":"eu","fingerprint":"labore adipisicing culpa tempor","country":"US","statement_description":"commodo ullamco","ach_details":{"routing_number":"commodo in voluptate officia","account_number_suffix":"no","account_type":"cupidatat"}},"wallet":{"status":"failed"},"external_details":{"type":"emoney","source":"occae","source_id":"eiusmod dolore ad Ut","source_fee_amount":2.5},"service_charges":[{"id":"12345","name":"Charge for delivery","amount":27500,"percentage":12.5,"currency":"USD","active":true,"type":"custom"},{"id":"12345","name":"Charge for delivery","amount":27500,"percentage":12.5,"currency":"USD","active":true,"type":"auto_gratuity"}],"custom_mappings":{},"updated_by":"12345","created_by":"12345","updated_at":"2020-09-30T07:43:32.000Z","created_at":"2020-09-30T07:43:32.000Z"},{"source_id":"12345","customer_id":"12345","amount":27.5,"currency":"USD","order_id":"12345","tender_id":"12345","id":"12345","merchant_id":"12345","employee_id":"12345","location_id":"12345","device_id":"12345","external_payment_id":"12345","idempotency_key":"random_string","tip":7,"tax":20,"total":37.5,"app_fee":3,"change_back_cash_amount":20,"approved":37.5,"refunded":37.5,"processing_fees":[{"amount":1.05,"effective_at":"2020-09-30T07:43:32.000Z","processing_type":"initial"}],"source":"external","status":"approved","cash":{"amount":{"description":"The amount of cash given by the customer."},"charge_back_amount":{"description":"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."}},"card_details":{"card":{"id":"12345","bin":"41111","card_brand":"square-capital-card","card_type":"credit","prepaid_type":"prepaid","cardholder_name":"John Doe","customer_id":"12345","merchant_id":"12345","exp_month":1,"exp_year":2022,"fingerprint":" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.","last_4":"The last 4 digits of the card number.","enabled":true,"billing_address":{"id":"123","type":"primary","string":"25 Spring Street, Blackburn, VIC 3130","name":"HQ US","line1":"Main street","line2":"apt #","line3":"Suite #","line4":"delivery instructions","street_number":"25","city":"San Francisco","state":"CA","postal_code":"94104","country":"US","latitude":"40.759211","longitude":"-73.984638","county":"Santa Clara","contact_name":"Elon Musk","salutation":"Mr","phone_number":"111-111-1111","fax":"122-111-1111","email":"elon@musk.com","website":"https://elonmusk.com","notes":"Address notes or delivery instructions.","row_version":"1-12345"},"reference_id":"card-001","version":"230320320320"}},"bank_account":{"bank_name":"eiusmod pariatur Lorem","transfer_type":"in eiusmod elit consectetur dolor","account_ownership_type":"ut aliqua culpa","fingerprint":"elit reprehenderit","country":"US","statement_description":"nulla voluptate aliquip et","ach_details":{"routing_number":"ullamco esse exercitation nulla ea","account_number_suffix":"a","account_type":"culpa"}},"wallet":{"status":"failed"},"external_details":{"type":"crypto","source":"dolor","source_id":"voluptate nisi aliquip aliqua","source_fee_amount":2.5},"service_charges":[{"id":"12345","name":"Charge for delivery","amount":27500,"percentage":12.5,"currency":"USD","active":true,"type":"custom"},{"id":"12345","name":"Charge for delivery","amount":27500,"percentage":12.5,"currency":"USD","active":true,"type":"custom"}],"custom_mappings":{},"updated_by":"12345","created_by":"12345","updated_at":"2020-09-30T07:43:32.000Z","created_at":"2020-09-30T07:43:32.000Z"}],"meta":{"items_on_page":50,"cursors":{"previous":"em9oby1jcm06OnBhZ2U6OjE=","current":"em9oby1jcm06OnBhZ2U6OjI=","next":"em9oby1jcm06OnBhZ2U6OjM="}},"links":{"previous":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D","current":"https://unify.apideck.com/crm/companies","next":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}}