payments
:: services/payments module

Get upcoming students' payments, account numbers, interests plans and many more

Methods

choose_installment_plan Choose installment plan for a given payment
installment An installment object
installment_plan Installments plans
payment An object representing users payment
remittance An object representing remittance
user_accounts Get access token issuer's banking accounts
user_payments Get access token issuer's payments
user_remittances Get access token issuer's remittances

services/payments/choose_installment_plan

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/choose_installment_plan

Choose installment plan for a given payment
payment_id required ID of payment
plan_id required ID of installment plan
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

Empty dict on success

services/payments/installment

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/installment

An installment object
installment_plan_id required ID of an installment plan
number required number of installment
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of following fields and their values:

  • amount - amount of an installment;

  • payment_date - a payment date;

  • description - a langdict object with description;

  • installment_plan_id - ID of a plan;

  • number - number of installment.

services/payments/installment_plan

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/installment_plan

Installments plans
installment_plan_id required ID of a plan
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of following fields and their values:

  • id - ID of a plan;

  • is_default - True if selected plan is default one;

  • currency - currency of a plan;

  • installments - List of installments associated with plan.

    This field references objects returned by installment method. See its returns section for possible subfields.

services/payments/payment

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/payment

An object representing users payment
id required ID of installment plan
type optional

Default value: (For legacy module this value is unused)

Payment type

Possible values: dormitory, tuition_fee, deposit, interest, retake_of_study_period, conditional_promotion, course_registration, course_retake, credit_point, token, others.
fields optional

Default value: id|user|saldo_amount|chosen_installment_plan|who_chose_plan|date_of_plan_choice|available_installment_plans|type|description|state|account_number|payment_deadline|bonus_deadline|bonus_amount|has_bonus|interest|total_amount|currency|faculty|default_choice_date

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - Payment ID. Might be null in case of virtual payments;

  • user - User that payment is defined for.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • saldo_amount - Current saldo of payment;

  • chosen_installment_plan - If a plan is chosen field contains object representing installment plan.

    This field references objects returned by installment_plan method. See its returns section for possible subfields.

  • who_chose_plan - User who have chosen installment plan.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • date_of_plan_choice - Date of choice of installment plan;

  • available_installment_plans - List of available installment plans for this payment.

    This field references objects returned by installment_plan method. See its returns section for possible subfields.

  • type - One of following values;

  • description - A langdict object, at this moment always only "pl" key may be not null;

  • state - One of following values;

  • account_number - Bank account number for payment;

  • payment_deadline - Payment date;

  • bonus_deadline - Deadline for bonus;

  • bonus_amount - Bonus amount;

  • has_bonus - Does the payment have bonus;

  • interest - Interests for today;

  • total_amount - Total amount of money to pay, with bonus and interest;

  • currency - Payment currency;

  • faculty - Payment faculty;

  • default_choice_date - Date when default plan will be chosen automatically.

services/payments/remittance

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/remittance

An object representing remittance
id required ID of remittance
fields optional

Default value: id|remaining|description|amount|status|is_settled|date

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - Remittance ID;

  • user - User that remittance is defined for.

    This field references objects returned by services/users/user method. See its returns section for possible subfields.

  • remaining - Remaining amount;

  • description - Description;

  • amount - Remittance amount;

  • status - Status;

  • is_settled - Is remittance settled;

  • date - Date of remittance;

  • currency - Payment currency;

  • faculty - Payment faculty.

services/payments/user_accounts

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/user_accounts

Get access token issuer's banking accounts
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

List of objects representing accounts. Each dictionary contains following fields:

  • account_number - Account number.;

  • name - Account name.;

  • title_prefix - Account title prefix.;

  • faculty - Faculty owning account.;

  • currency - Account currency.;

  • swift - Swift code of the account. Might be null..

Warning: these accounts numbers are related to user faculties and not to payments! They are for informational purposes only!

services/payments/user_payments

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/user_payments

Get access token issuer's payments
fields optional

Default value: id|user|saldo_amount|chosen_installment_plan|who_chose_plan|date_of_plan_choice|available_installment_plans|type|description|state|account_number|payment_deadline|bonus_deadline|bonus_amount|has_bonus|interest|total_amount|currency|faculty|default_choice_date

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of payment method.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

List of objects returned by method payment

services/payments/user_remittances

Consumer: required Token: required Scopes: payments SSL: required
https://usosapi.panschelm.edu.pl/services/payments/user_remittances

Get access token issuer's remittances
fields optional

Default value: id|remaining|description|amount|status|is_settled|date

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of remittance method.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional

Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

List of objects returned by method remittance
USOS API ver. 7.1.0.0-4, 0e1fe7fc (2024-08-27)