Skip to content

user_payment

Manage user's payment settings

Create

Path
POST /v7.0/user_payments
Description
Create a user payment
Authentication required
yes
Scope
user_payment#create
Aliases
new
Blocking
yes

Input parameters

Layout
object
Namespace
user_payment
ParameterTypeRequiredDetails
incoming_payment
IncomingPayment
 Resource no
user
User
 Resource yes
amount
Amount
 Integer no

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 1 (inclusive).

Validation error message: must be at least 1

Output parameters

Layout
object
Namespace
user_payment
ParameterTypeDescription
id
Id
 Integer
incoming_payment
IncomingPayment
 Resource
user
User
 Resource
amount
Amount
 Integer
accounted_by
Accounted_by
 Resource
from_date
From_date
 Datetime Paginate by create/update date
to_date
To_date
 Datetime
created_at
Created_at
 Datetime

Index

Path
GET /v7.0/user_payments
Description
List user payments
Authentication required
yes
Scope
user_payment#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
user_payment
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

Continue after this payment, ordered by creation time from newest to oldest. Use the last payment ID from the previous page and keep the same filters. Returns an empty list if the payment is unavailable or does not match the filters.

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
user
User
 Resource no
accounted_by
Accounted_by
 Resource no
created_from
Created from
 Datetime no

Include payments created at or after this timestamp

Default: null
created_to
Created to
 Datetime no

Include payments created at or before this timestamp

Default: null

Output parameters

Layout
object_list
Namespace
user_payments
ParameterTypeDescription
id
Id
 Integer
incoming_payment
IncomingPayment
 Resource
user
User
 Resource
amount
Amount
 Integer
accounted_by
Accounted_by
 Resource
from_date
From_date
 Datetime Paginate by create/update date
to_date
To_date
 Datetime
created_at
Created_at
 Datetime

Show

Path
GET /v7.0/user_payments/{user_payment_id}
Description
Show user payment
Authentication required
yes
Scope
user_payment#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
user_payment
ParameterTypeDescription
id
Id
 Integer
incoming_payment
IncomingPayment
 Resource
user
User
 Resource
amount
Amount
 Integer
accounted_by
Accounted_by
 Resource
from_date
From_date
 Datetime Paginate by create/update date
to_date
To_date
 Datetime
created_at
Created_at
 Datetime