Skip to content

incoming_payment

Browse incoming payments

Index

Path
GET /v7.0/incoming_payments
Description
List incoming payments
Authentication required
yes
Scope
incoming_payment#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
incoming_payment
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

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: 25

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
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • queued
  • unmatched
  • processed
  • ignored

Validation error message: %{value} cannot be used

Output parameters

Layout
object_list
Namespace
incoming_payments
ParameterTypeDescription
id
Id
 Integer
transaction_id
Transaction_id
 String
state
State
 String
date
Date
 Datetime
amount
Amount
 Integer
currency
Currency
 String
src_amount
Src_amount
 Integer
src_currency
Src_currency
 String
account_name
Account_name
 String
user_ident
User_ident
 String
user_message
User_message
 String
vs
Vs
 String
ks
Ks
 String
ss
Ss
 String
transaction_type
Transaction_type
 String
comment
Comment
 String Optional comment
created_at
Created_at
 Datetime

Show

Path
GET /v7.0/incoming_payments/{incoming_payment_id}
Description
Show incoming payment
Authentication required
yes
Scope
incoming_payment#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
incoming_payment
ParameterTypeDescription
id
Id
 Integer
transaction_id
Transaction_id
 String
state
State
 String
date
Date
 Datetime
amount
Amount
 Integer
currency
Currency
 String
src_amount
Src_amount
 Integer
src_currency
Src_currency
 String
account_name
Account_name
 String
user_ident
User_ident
 String
user_message
User_message
 String
vs
Vs
 String
ks
Ks
 String
ss
Ss
 String
transaction_type
Transaction_type
 String
comment
Comment
 String Optional comment
created_at
Created_at
 Datetime

Update

Path
PUT /v7.0/incoming_payments/{incoming_payment_id}
Description
Change payment's state
Authentication required
yes
Scope
incoming_payment#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
incoming_payment
ParameterTypeRequiredDetails
state
State
 String yes

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • queued
  • unmatched
  • processed
  • ignored

Validation error message: %{value} cannot be used

Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
incoming_payment
ParameterTypeDescription
id
Id
 Integer
transaction_id
Transaction_id
 String
state
State
 String
date
Date
 Datetime
amount
Amount
 Integer
currency
Currency
 String
src_amount
Src_amount
 Integer
src_currency
Src_currency
 String
account_name
Account_name
 String
user_ident
User_ident
 String
user_message
User_message
 String
vs
Vs
 String
ks
Ks
 String
ss
Ss
 String
transaction_type
Transaction_type
 String
comment
Comment
 String Optional comment
created_at
Created_at
 Datetime