• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Payment created

EVENT payment.created

Published when a Payment is created.

Required permissions: PAYMENTS_READ

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "payment.created".

event_id
string

A unique ID for the webhook event.

created_at
string

Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
PaymentCreatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "payment.created",
  "event_id": "13b867cf-db3d-4b1c-90b6-2f32a9d78124",
  "created_at": "2020-02-06T21:27:30.792Z",
  "data": {
    "type": "payment",
    "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
    "object": {
      "payment": {
        "id": "KkAkhdMsgzn59SM8A89WgKwekxLZY",
        "created_at": "2020-02-06T21:27:30.444Z",
        "updated_at": "2020-02-06T21:27:30.590Z",
        "amount_money": {
          "amount": 1000,
          "currency": "USD"
        },
        "total_money": {
          "amount": 1000,
          "currency": "USD"
        },
        "status": "APPROVED",
        "source_type": "CARD",
        "card_details": {
          "auth_result_code": "YFB91d",
          "avs_status": "AVS_ACCEPTED",
          "card": {
            "bin": "411111",
            "card_brand": "VISA",
            "card_type": "CREDIT",
            "exp_month": 2,
            "exp_year": 2022,
            "fingerprint": "sq-1-pu54rLMT5m8qddqnsWaSBI9zJkDH_mMy8hC2qe6MUzdP4MCSHaHZtm_XNuiiso95gQ",
            "last_4": "1111"
          },
          "cvv_status": "CVV_ACCEPTED",
          "entry_method": "KEYED",
          "statement_description": "SQ *MY BUSINESS",
          "status": "AUTHORIZED"
        },
        "location_id": "NAQ1FHV6ZJ8YV",
        "order_id": "j3WfFVLi7XdcrH3BxoV0L3EHqe4F",
        "receipt_number": "KkAk",
        "receipt_url": "https://squareup.com/receipt/preview/KkAkhdMsgzn59SM8A89WgKwekxLZY",
        "reference_id": "123456",
        "note": "Brief description",
        "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
        "version": 1
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?