• postUpdate payment status

API docs by Redocly

Square notifications API (0)

Download OpenAPI specification:Download

This API will be used by Square to send notifications related to Square payments.

NewStore partners with Square as the PSP for retailers with stores in Japan. To integrate Square with NewStore, see Integrating Square.

To configure Square, contact the support team.

Update payment status

When this method is called by Square, the status of the payment transaction is updated in the NewStore platform.

Each message has a type and a data field with the event payload. The integration should be configured in the Square portal.

Request Body schema: application/json

type required	string The type of event that triggered the webhook. Example: payment.created, payment.updated
required	object

Responses

/_/v1/org/psps/square/notifications

Request samples

• Payload

Content type

application/json

{

• "type": "payment.created",
• "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",
      • "total_money": {

        • "amount": 1000,
        • "currency": "USD"

        },
      • "status": "APPROVED",
      • "card_details": {

        • "card": {

          • "card_brand": "VISA",
          • "last_4": "1111"

          }

        },
      • "location_id": "NAQ1FHV6ZJ8YV",
      • "order_id": "j3WfFVLi7XdcrH3BxoV0L3EHqe4F",
      • "version": 1

      }

    }

  }

}