List payments

GET

/api/v1/payments

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/payments?page=1&limit=25' \
  --header 'Authorization: Bearer <token>'

Paginated; filter by invoice_id or lead_id. Limited to the payments the caller may view (own, team or all).

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Query Parameters

page

number

default: 1 >= 1

limit

number

default: 25 >= 1 <= 100

invoice_id

string

/^[0-9a-fA-F]{24}$/

lead_id

string

/^[0-9a-fA-F]{24}$/

Responses

200

A page of payments

Media typeapplication/json

object

payments

required

Array<object>

object

_id

required

string

invoice_id

required

string

amount

required

number

method

required

string

status

required

string

key

additional properties

any

total

required

number

page

required

number

limit

required

number

totalPages

required

number

Example^generated

{
  "payments": [
    {
      "_id": "example",
      "invoice_id": "example",
      "amount": 1,
      "method": "example",
      "status": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "totalPages": 1
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}