Table of Contents
Routes
- withdraw-payment-systems
- withdraw-requisites
- withdraws
Routes
withdraw-payment-systems
GET withdraw-payment-systems/
Gets the API list of payment systems.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| PB_WithdrawalQueue_PaymentSystem[] | mixed | |
GET withdraw-payment-systems/{id}/
Gets information about the specified payment system.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| paymentSystem | PB_WithdrawalQueue_PaymentSystem | |
DELETE withdraw-payment-systems/{id}/
Deletes the specified payment system.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
withdraw-requisites
GET withdraw-requisites/
Gets the API user's list of withdrawal queue requisites.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| requisites | PB_WithdrawalQueue_Requisite[] | |
POST withdraw-requisites/
Creates the specified requisite
| Inputs | Type | Description |
|---|
| system_id | integer | [req] |
| wallet | string | |
| custom_fields[<name>] | string | |
GET withdraw-requisites/{id}/
Gets information about the specified requisite.
| Inputs | Type | Description |
|---|
| None. |
POST withdraw-requisites/{id}/
Updates the specified requisite
| Inputs | Type | Description |
|---|
| wallet | string | |
| custom_fields[<name>] | string | |
DELETE withdraw-requisites/{id}/
Deletes the specified requisite.
| Inputs | Type | Description |
|---|
| None. |
| Outputs | Type | Description |
|---|
| success | true | |
withdraws
GET withdraws/
Gets the API user's list of withdrawal requests.
| Inputs | Type | Description |
|---|
| page | integer | |
| user_id | integer | |
| withdraw_state | string | Possible states: pending, sent, rejected |
| Outputs | Type | Description |
|---|
| requisites | PB_WithdrawalQueue_Withdraw[] | |
| pagination | pagination | |
GET withdraws/{id}/
Gets information about the specified withdraw.
| Inputs | Type | Description |
|---|
| None. |
POST withdraws/{id}/
Updates the specified withdraw
| Inputs | Type | Description |
|---|
| withdraw_state | string | Possible states: pending, sent, rejected |
| payout | float | |
| reject_reason | string | |
Types
PB_WithdrawalQueue_Requisite
| Structure | Type | Description |
|---|
| requisite_id | integer | |
| system_id | integer | |
| user_id | integer | |
| custom_fields | object | |
| wallet | string | |
| create_date | integer | |
| update_date | integer | |
PB_WithdrawalQueue_RequisiteField
| Structure | Type | Description |
|---|
| field_id | string | |
| title | string | |
| description | string | |
| display_order | integer | |
| field_type | string | |
| field_choices | object | [cond] For choice types, an ordered list of choices, with "option" and "name" keys for each. |
| match_type | string | |
| match_params | array | |
| max_length | integer | |
| required | bool | |
| display_group | string | [cond] If this field type supports grouping, the group this field belongs to. |
PB_WithdrawalQueue_Withdraw
| Structure | Type | Description |
|---|
| withdraw_id | integer | |
| user_id | integer | |
| username | string | |
| update_user_id | integer | |
| update_username | string | |
| sum | float | |
| payout | float | |
| charged | float | |
| commission | float | |
| withdraw_state | string | |
| reject_reason | string | |
| requisite_id | integer | |
| wallet | string | |
| system_id | integer | |
| system_title | string | |
| state_phrase | string | |
| create_date | integer | |
| update_date | integer | |
| formatted_requested_amount | string | |
| formatted_payout_amount | string | |
| formatted_charged_amount | string | |
| currency_addon | string | |
| currency_id | integer | |
| payout_currency | string | |