Skip to main content

Update a Payment

ENDPOINT
PUT https://api.codecoogs.com/v1/payments?id=
REQUEST BODY
{
"id": "eec23d65-a56a-48b1-89c1-6c36068dbfb6",
"payer": "0f516377-d5a8-420b-ab2b-ec3075fb59d8",
"payee": "9eafedd1-64cb-42f7-88ff-3a49f20cc1d7",
"name": "Coco's Amazing Pizza Party",
"price": 60,
"quantity": 4,
"description": "Pizza party celebration",
"method": "Zelle",
"expiration": null
}

URL Parameters


id Required

A UUID for the object.

Body Parameters


id string

A UUID for the object.


payer string

The UUID of the user making the payment.


payee string

The UUID of the user recieving the payment.


name string

The payment's name.


price integer

The price of the payment.


quantity integer

The number of items bought.


description string

The payment's description.


method string

The payment method used.


expiration string Optional

The payment's expiration date.

Updating Payment Attributes

When updating a payment's information, if you prefer to keep certain attributes unchanged, simply include their current values in the request body. This ensures that only the desired attributes are modified, while retaining the existing values for those you wish to remain unchanged.

Returns

Returns a success status after successful payment update. This call returns a success status and an error message if something goes wrong.