.. AUTO-GENERATED FILE. DO NOT EDIT.

store-payments-patch-one
========================

Source
------

- Repository: ``jef-systems/jef-store-backend``
- Source Run ID: ``25334823297``
- Source SHA: ``69cb846339fa14db005aec45414a4a94ec2a821e``
- Module: ``store``
- Documentation Scope: ``async``
- Lambda: ``jef-store-patch-47``

Endpoint
--------

- API Name: ``jef-store``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/store-payments-patch-one``
- Complete Endpoint: ``https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-payments-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-store-patch-47``
- curl payload mode: ``json_body``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-store-patch-47
   Module: jef-store
   Action: patch
   Method: PATCH
   Invocation Mode: ASYNC
   Resource Path: /store-payments-patch-one
   
   API Gateway Response:
   - status_code: 202
   - message: Request accepted for asynchronous processing.
   
   Table:
   - table: jef-store-payments
   
   Payload Example:
   - pk: payment-1001-0001
   - gsi_1_pk: ORD-1001-0001
   - gsi_1_sk: 2026-05-04T09:07:00+08:00
   - gsi_2_pk: Pandan Coconut Sea Salt Latte payment reference 1001-0001
   - gsi_2_sk: 2026-05-04T09:07:00+08:00
   - payment_id: payment-1001-0001
   - entity_number: 1001
   - order_number: ORD-1001-0001
   - payment_reference: Pandan Coconut Sea Salt Latte payment reference 1001-0001
   - payment_method: Pandan Coconut Sea Salt Latte payment method 1001-0001
   - payment_status: paid
   - amount_due: 1896
   - amount_paid: 1896
   - paid_at: 2026-05-04T09:07:00+08:00
   - failure_reason: Pandan Coconut Sea Salt Latte failure reason 1001-0001
   - is_active: true
   - is_deleted: false
   - deleted_at: 
   - created_at: 2026-05-04T09:07:00+08:00
   - updated_at: 2026-05-04T09:07:00+08:00
   - idempotency_key: 0c36ca1f-221f-5aa5-a75b-09ad1919e44d
   - schema_version: 1001
   - version: 1001
   
   Payload Schema:
   - pk: string-{payment_id}
   - gsi_1_pk: string-{order_number}
   - gsi_1_sk: string-{created_at}
   - gsi_2_pk: string-{payment_reference}
   - gsi_2_sk: string-{created_at}
   - payment_id: string
   - entity_number: string
   - order_number: string
   - payment_reference: string
   - payment_method: string
   - payment_status: string
   - amount_due: number
   - amount_paid: number
   - paid_at: string
   - failure_reason: string
   - is_active: boolean
   - is_deleted: boolean
   - deleted_at: string
   - created_at: string
   - updated_at: string
   - idempotency_key: string
   - schema_version: number
   - version: number
   
   Response Schema:
   - is_accepted: boolean
   - message: string

Request Payload
---------------

.. code-block:: json

   {
     "pk": "payment-1001-0001",
     "gsi_1_pk": "ORD-1001-0001",
     "gsi_1_sk": "2026-05-04T09:07:00+08:00",
     "gsi_2_pk": "Pandan Coconut Sea Salt Latte payment reference 1001-0001",
     "gsi_2_sk": "2026-05-04T09:07:00+08:00",
     "payment_id": "payment-1001-0001",
     "entity_number": "1001",
     "order_number": "ORD-1001-0001",
     "payment_reference": "Pandan Coconut Sea Salt Latte payment reference 1001-0001",
     "payment_method": "Pandan Coconut Sea Salt Latte payment method 1001-0001",
     "payment_status": "paid",
     "amount_due": "1896",
     "amount_paid": "1896",
     "paid_at": "2026-05-04T09:07:00+08:00",
     "failure_reason": "Pandan Coconut Sea Salt Latte failure reason 1001-0001",
     "is_active": "true",
     "is_deleted": "false",
     "deleted_at": "",
     "created_at": "2026-05-04T09:07:00+08:00",
     "updated_at": "2026-05-04T09:07:00+08:00",
     "idempotency_key": "0c36ca1f-221f-5aa5-a75b-09ad1919e44d",
     "schema_version": "1001",
     "version": "1001"
   }

Response
--------

.. code-block:: json

   {
     "is_accepted": "boolean",
     "message": "string"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-payments-patch-one" -H "Content-Type: application/json" --data-raw "{\"pk\": \"payment-1001-0001\", \"gsi_1_pk\": \"ORD-1001-0001\", \"gsi_1_sk\": \"2026-05-04T09:07:00+08:00\", \"gsi_2_pk\": \"Pandan Coconut Sea Salt Latte payment reference 1001-0001\", \"gsi_2_sk\": \"2026-05-04T09:07:00+08:00\", \"payment_id\": \"payment-1001-0001\", \"entity_number\": \"1001\", \"order_number\": \"ORD-1001-0001\", \"payment_reference\": \"Pandan Coconut Sea Salt Latte payment reference 1001-0001\", \"payment_method\": \"Pandan Coconut Sea Salt Latte payment method 1001-0001\", \"payment_status\": \"paid\", \"amount_due\": 1896, \"amount_paid\": 1896, \"paid_at\": \"2026-05-04T09:07:00+08:00\", \"failure_reason\": \"Pandan Coconut Sea Salt Latte failure reason 1001-0001\", \"is_active\": \"true\", \"is_deleted\": \"false\", \"deleted_at\": \"\", \"created_at\": \"2026-05-04T09:07:00+08:00\", \"updated_at\": \"2026-05-04T09:07:00+08:00\", \"idempotency_key\": \"0c36ca1f-221f-5aa5-a75b-09ad1919e44d\", \"schema_version\": 1001, \"version\": 1001}"

PowerShell curl
---------------

.. code-block:: text

   curl.exe -X PATCH "https://rw53l0a90m.execute-api.ap-southeast-1.amazonaws.com/prod/store-payments-patch-one" -H "Content-Type: application/json" --data-raw '{"pk": "payment-1001-0001", "gsi_1_pk": "ORD-1001-0001", "gsi_1_sk": "2026-05-04T09:07:00+08:00", "gsi_2_pk": "Pandan Coconut Sea Salt Latte payment reference 1001-0001", "gsi_2_sk": "2026-05-04T09:07:00+08:00", "payment_id": "payment-1001-0001", "entity_number": "1001", "order_number": "ORD-1001-0001", "payment_reference": "Pandan Coconut Sea Salt Latte payment reference 1001-0001", "payment_method": "Pandan Coconut Sea Salt Latte payment method 1001-0001", "payment_status": "paid", "amount_due": 1896, "amount_paid": 1896, "paid_at": "2026-05-04T09:07:00+08:00", "failure_reason": "Pandan Coconut Sea Salt Latte failure reason 1001-0001", "is_active": "true", "is_deleted": "false", "deleted_at": "", "created_at": "2026-05-04T09:07:00+08:00", "updated_at": "2026-05-04T09:07:00+08:00", "idempotency_key": "0c36ca1f-221f-5aa5-a75b-09ad1919e44d", "schema_version": 1001, "version": 1001}'