Payment
CreatePayment
POST https://api.opentact.org/rest/payment
Create payment
Headers
X-Auth-Token
string
JWT
Content-Type
string
application-json
Request Body
provider
string
(EPaymentProvider)
Enum: "paypal" "stripe" "unknown"
amount
number
<float> >=0
Payment amount
Code Example
ListPayments
GET https://api.opentact.org/rest/payment
Get user payments list
Headers
X-Auth-Token
string
JWT
UpdatePayment
PATCH https://api.opentact.org/rest/payment/{uuid}
Update payment state
Headers
X-Auth-Token
string
JWT
Request Body
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
payment uuid
GetPaymentByUUID
GET https://api.opentact.org/rest/payment/{uuid}
Get payment by uuid
Headers
X-Auth-Token
string
JWT
Request Body
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
SearchTransactions
POST https://api.opentact.org/rest/payment
Search transactions
Query Parameters
take
integer
<int32> [ 1 .. 100 ]
Default: 10
skip
integer
<int32> >=0
Default: 0
Headers
X-Auth-Token
string
JW
Content-Type
string
application/json
Request Body
take
integer
<int32> [ 1 .. 100 ]
Default: "10"
how many items to take
skip
integer
<int32> >=0
Default: "0"
how many items to skip
mode
string
(ESearchMode)
Enum: "AND" "OR"
order
object
Order items by field's Accepted Values: account_balance_before account_balance_after amount ref_type created_on modified_on
created_on_to
string
<date-time>
modified_on_from
string
<date-time>
modified_on_to
string
<date-time>
account_balance_before
number
<float>
account_balance_after
number
<float>
amount
number
<float>
ref_type
string
(ETransactionReferenceType)
Enum: "payment" "tnlease_mrc" "tnlease_nrc" "sms_incoming" "sms_outgoing" "sms_nrc" "sms_mrc" "mms_incoming" "mms_outgoing" "mms_nrc" "mms_mrc" "voice_incoming" "voice_outgoing" "voice_nrc" "voice_mrc" "fax_incoming" "fax_outgoing" "fax_nrc" "fax_mrc" "emergency_incoming" "emergency_outgoing" "emergency_nrc" "emergency_mrc"
created_on_from
string
<date-time>
GetTransactionByUUID
GET https://api.opentact.org/rest/transaction/{uuid}
Get extended transaction info
Headers
X-Auth-Token
string
JWT
Request Body
uuid
string
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
payment uuid
GetTransactionInvoiceReport
GET https://api.opentact.org/rest/transaction/report/invoice
Get invoice report
Query Parameters
from
string
<date-time> report FROM date. First day of prev month by default
to
string
<date-time> report TO date. First day of current month by default
Headers
X-Auth-Token
string
JWT
Last updated
Was this helpful?