v1

latestOpenAPI 3.0.0Apache 2.02026-07-134699335.3 KB

Payments

Get Payment

get/pos/payments/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

fieldsstring nullable

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

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-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Response

PosPayments

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "square",
  "resource": "PosPayments",
  "operation": "one",
  "data": {
    "id": "12345",
    "source_id": "12345",
    "order_id": "12345",
    "merchant_id": "12345",
    "customer_id": "12345",
    "employee_id": "12345",
    "location_id": "12345",
    "device_id": "12345",
    "tender_id": "12345",
    "external_payment_id": "12345",
    "idempotency_key": "random_string",
    "amount": 27.5,
    "currency": "USD",
    "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",
    "card_details": {
      "card": {
        "id": "12345",
        "bin": "41111",
        "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",
          "line5": "Attention: Finance Dept",
          "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": {
      "country": "US"
    },
    "external_details": {
      "source_fee_amount": 2.5
    },
    "service_charges": [
      {
        "id": "12345",
        "name": "Charge for delivery",
        "amount": 27500,
        "percentage": 12.5,
        "currency": "USD",
        "active": true
      }
    ],
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "pass_through": [
      {
        "extend_paths": [
          {
            "path": "$.nested.property",
            "value": {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000"
              }
            }
          }
        ]
      }
    ]
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  }
}