v1

latestOpenAPI 3.0.0Apache 2.02026-07-134699335.3 KB

Payments

Update Payment

patch/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

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.

Request body

idstring

A unique identifier for an object.

source_idstring 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_idstring required

merchant_idstring

customer_idstring required

employee_idstring

location_idstring

device_idstring

tender_idstring required

external_payment_idstring

idempotency_keystring

A value you specify that uniquely identifies this request among requests you have sent.

amountnumber 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.

tipnumber

taxnumber

totalnumber

app_feenumber

The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.

change_back_cash_amountnumber

approvednumber

The initial amount of money approved for this payment.

refundednumber

The initial amount of money approved for this payment.

Source of this payment.

Status of this payment.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "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"
            }
          }
        }
      ]
    }
  ]
}

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": "update",
  "data": {
    "id": "12345"
  }
}