Collections

Update collections

put/api/v1/Collections

Request

  • Base URL: https://api.payex.io
  • URL: https://api.payex.io/api/v1/Collections
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

titlestring

Title of the collection

descriptionstring

Description of the collection

Example request

{
  "title": "Fruits",
  "description": "Fruit basket delivery"
}

Response

Success

idstring

Id of the collection

titlestring

Title of the collection

descriptionstring

Description of the collection

defaultboolean

Whether collection is default or not

type'one_time' | 'recurring'

If collection is for one-time payments, or recurring payments

Changes

No recorded changes to this operation across all 1 revision of this API.