List Donation Sessions

GET 
/v1/donation-sessions

List Donation Sessions

Request

Query Parameters

direction string

Possible values: [ASC, DESC]

Which way to sort by the given 'sort' field. Default DESC

cursor string

A cursor that points to where to start the page

pageSize integer

Default value: 25

How many items per page, for pagination.

Responses

200

Successfully lists Donation Sessions

application/json

Schema

Schema

data object[]
Array [
id string
organisationId string
successUrl stringnullable
Optional URL the donor will be directed to after making a donation.
userId stringnullable
Id of the User who this donation belongs to, if one exists.
url string
status string
Possible values: [open, completed, expired]
createdAt date-time
expiresAt date-time
language string
Default value: en-GB
metadata objectnullable
Key-value data that you can attach to an object. When a Donation is created from a DonationSession, the DonationSession copies its metadata to the Donation.
currency stringnullable
]
object string
totalResults integer
pageSize integer
_links object
current string
next string
prev string

Example (from schema)

{
  "data": [
    {
      "id": "donationsession_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "organisationId": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "successUrl": "https://example.com/donation-completed",
      "userId": "user_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "url": "https://donate.poweredbypercent.com/donation-session",
      "status": "open",
      "createdAt": "2021-10-13T17:46:54.000Z",
      "expiresAt": "2021-10-13T17:46:54.000Z",
      "language": "en-GB",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "currency": "GBP"
    }
  ],
  "object": "donation_session",
  "totalResults": 33,
  "pageSize": 25,
  "_links": {
    "current": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "next": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D",
    "prev": "https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D"
  }
}

400

Bad request

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

CursorError

Error in cursor parameter

{
  "error": {
    "code": "pagination/cursor_error",
    "title": "Bad request",
    "message": "Unable to find the next page"
  }
}

OriginalCallInProgress

Idempotency - Original call in progress

{
  "error": {
    "code": "idempotency/original_call_in_progress",
    "title": "Bad request",
    "message": "Original call with this idempotency key is still in progress"
  }
}

SameKeyDifferentData

Idempotency - Data has changed from previous request

{
  "error": {
    "code": "idempotency/same_key_different_data",
    "title": "Bad request",
    "message": "Data has changed from previous request"
  }
}

KeyInUse

Idempotency - Key in use

{
  "error": {
    "code": "idempotency/key_already_in_use",
    "title": "Bad request",
    "message": "Idempotency Key is already in use"
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...