--- title: "Get Payment" method: GET path: "/pos/payments/{id}" tags: ["Payments"] --- # Get Payment `GET /pos/payments/{id}` Get Payment ## Path parameters - `id` string, required ## Query parameters - `raw` boolean - `fields` string, nullable ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string ## Response `200` PosPayments - GetPosPaymentResponse - `status_code` integer, required — HTTP Response Status Code - `status` string, required — HTTP Response Status - `service` string, required — Apideck ID of service provider - `resource` string, required — Unified API resource name - `operation` string, required — Operation performed - `data` PosPayment, required - `id` string — A unique identifier for an object. - `source_id` string, required — The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`. - `order_id` string, required - `merchant_id` string - `customer_id` string, required - `employee_id` string - `location_id` string - `device_id` string - `tender_id` string, required - `external_payment_id` string - `idempotency_key` string — A value you specify that uniquely identifies this request among requests you have sent. - `amount` number, required - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable, required — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `tip` number - `tax` number - `total` number - `app_fee` number — The amount the developer is taking as a fee for facilitating the payment on behalf of the seller. - `change_back_cash_amount` number - `approved` number — The initial amount of money approved for this payment. - `refunded` number — The initial amount of money approved for this payment. - `processing_fees` object[] - `amount` number - `effective_at` string, date-time - `processing_type` 'initial' | 'adjustment' - `source` 'card' | 'bank_account' | 'wallet' | 'bnpl' | 'cash' | 'external' | 'other' — Source of this payment. - `status` 'approved' | 'pending' | 'completed' | 'canceled' | 'failed' | 'other' — Status of this payment. - `cash` object — Cash details for this payment - `amount` unknown - `charge_back_amount` unknown - `card_details` object - `card` PaymentCard, nullable — A card's non-confidential details. - `id` string — A unique identifier for an object. - `bin` string, nullable — The first six digits of the card number, known as the Bank Identification Number (BIN). - `card_brand` 'visa' | 'mastercard' | 'amex' | 'discover' | 'discover-diners' | 'jcb' | 'china-unionpay' | 'square-gift-card' | 'square-capital-card' | 'interac' | 'eftpos' | 'felica' | 'ebt' | 'other', nullable — The first six digits of the card number, known as the Bank Identification Number (BIN). - `card_type` 'credit' | 'debit' | 'prepaid' | 'other', nullable - `prepaid_type` 'non-prepaid' | 'prepaid' | 'unknown', nullable - `cardholder_name` string, nullable - `customer_id` string, nullable - `merchant_id` string - `exp_month` integer, nullable — The expiration month of the associated card as an integer between 1 and 12. - `exp_year` integer, nullable — The four-digit year of the card's expiration date. - `fingerprint` string, nullable - `last_4` string, nullable - `enabled` boolean, nullable — Indicates whether or not a card can be used for payments. - `billing_address` Address - `id` string, nullable — Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable — The type of address. - `string` string, nullable — The address string. Some APIs don't provide structured address data. - `name` string, nullable — The name of the address. - `line1` string, nullable — Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable — Line 2 of the address - `line3` string, nullable — Line 3 of the address - `line4` string, nullable — Line 4 of the address - `line5` string, nullable — Line 5 of the address - `street_number` string, nullable — Street number - `city` string, nullable — Name of city. - `state` string, nullable — Name of state - `postal_code` string, nullable — Zip code or equivalent. - `country` string, nullable — country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable — Latitude of the address - `longitude` string, nullable — Longitude of the address - `county` string, nullable — Address field that holds a sublocality, such as a county - `contact_name` string, nullable — Name of the contact person at the address - `salutation` string, nullable — Salutation of the contact person at the address - `phone_number` string, nullable — Phone number of the address - `fax` string, nullable — Fax number of the address - `email` string, nullable — Email address of the address - `website` string, nullable — Website of the address - `notes` string, nullable — Additional notes - `row_version` string, nullable — A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `reference_id` string, nullable — An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system. - `version` string, nullable - `bank_account` PosBankAccount — Card details for this payment. This field is currently not available. Reach out to our team for more info. - `bank_name` string — The name of the bank associated with the bank account. - `transfer_type` string — The type of the bank transfer. The type can be `ACH` or `UNKNOWN`. - `account_ownership_type` string — The ownership type of the bank account performing the transfer. The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`. - `fingerprint` string — Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account. - `country` string, nullable — Country code according to ISO 3166-1 alpha-2. - `statement_description` string — The statement description as sent to the bank. - `ach_details` object — ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`. - `routing_number` string — The routing number for the bank account. - `account_number_suffix` string — The last few digits of the bank account number. - `account_type` string — The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`. - `wallet` object — Wallet details for this payment. This field is currently not available. Reach out to our team for more info. - `status` 'authorized' | 'captured' | 'voided' | 'failed' | 'other' — The status of the wallet payment. The status can be AUTHORIZED, CAPTURED, VOIDED, or FAILED. - `external_details` object — Details about an external payment. - `type` 'check' | 'bank_transfer' | 'other_gift_card' | 'crypto' | 'square_cash' | 'social' | 'external' | 'emoney' | 'card' | 'stored_balance' | 'food_voucher' | 'other', required — The type of external payment the seller received. It can be one of the following: - CHECK - Paid using a physical check. - BANK_TRANSFER - Paid using external bank transfer. - OTHER\_GIFT\_CARD - Paid using a non-Square gift card. - CRYPTO - Paid using a crypto currency. - SQUARE_CASH - Paid using Square Cash App. - SOCIAL - Paid using peer-to-peer payment applications. - EXTERNAL - A third-party application gathered this payment outside of Square. - EMONEY - Paid using an E-money provider. - CARD - A credit or debit card that Square does not support. - STORED_BALANCE - Use for house accounts, store credit, and so forth. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here. - `source` string, required — A description of the external payment source. For example, "Food Delivery Service". - `source_id` string — An ID to associate the payment to its originating source. - `source_fee_amount` number — The fees paid to the source. The amount minus this field is the net amount seller receives. - `service_charges` ServiceCharge[] — Optional service charges or gratuity tip applied to the order. - `id` string — A unique identifier for an object. - `name` string — Service charge name - `amount` number - `percentage` number — Service charge percentage. Use this field to calculate the amount of the service charge. Pass a percentage and amount at the same time. - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `active` boolean, nullable - `type` 'auto_gratuity' | 'custom' — The type of the service charge. - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here. - `updated_by` string, nullable — The user who last updated the object. - `created_by` string, nullable — The user who created the object. - `updated_at` string, date-time, nullable — The date and time when the object was last updated. - `created_at` string, date-time, nullable — The date and time when the object was created. - `pass_through` object[] — The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required — Identifier for the service to which this pass_through should be applied. - `operation_id` string — Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object — Simple object allowing any properties for direct extension. - `extend_paths` object[] — Array of objects for structured data modifications via paths. - `path` string, required — JSONPath string specifying where to apply the value. - `value` unknown, required - `meta` Meta — Response metadata - `items_on_page` integer — Number of items returned in the data property of the response - `cursors` object — Cursors to navigate to previous or next pages through the API - `previous` string, nullable — Cursor to navigate to the previous page of results through the API - `current` string, nullable — Cursor to navigate to the current page of results through the API - `next` string, nullable — Cursor to navigate to the next page of results through the API - `total_count` integer — Number of records available in total for this resource - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200. - `type` string — Discriminator for the warning kind. - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available. - `error` string, nullable — Short error description from the downstream provider, when available. - `operation` string, nullable — Identifier of the workflow step that failed. - `message` string, nullable — Detailed message from the downstream provider, when available. - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `404` — The specified resource was not found - `422` — Unprocessable - `default` — Unexpected error --- [API](https://skmtc.net/apideck-libraries/apis/pos-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/pos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/pos-api/versions/32f93eb7c19e/schema)