Update a payment

Examples

curl -X PATCH https://komoju.com/api/v1/payments/at73tq9g8d0ruwp1h7468d3a3 \
  -u sk_123456: \
  -d "description=updated description" \
  -d "metadata[updated]=metadata" 
{
  "id": "at73tq9g8d0ruwp1h7468d3a3",
  "resource": "payment",
  "status": "pending",
  "amount": 300,
  "tax": 30,
  "customer": null,
  "payment_deadline": "2018-10-18T14:59:59Z",
  "payment_details": {
    "type": "konbini",
    "email": "gordon@example.com",
    "store": "circle-k",
    "confirmation_code": null,
    "receipt": "12345",
    "instructions_url": "https://komoju.com/en/instructions/at73tq9g8d0ruwp1h7468d3a3"
  },
  "payment_method_fee": 0,
  "total": 330,
  "currency": "JPY",
  "description": "updated description",
  "captured_at": null,
  "external_order_num": "ORDER3",
  "metadata": {
    "updated": "metadata"
  },
  "created_at": "2018-10-15T03:13:55Z",
  "amount_refunded": 0,
  "locale": "en",
  "refunds": [

  ],
  "refund_requests": [

  ]
}

Params

Param name Description
description
optional
Plaintext description for annotating a resource.
metadata
optional
A set of key-value pairs