Payments

Payment Logs

Get all online payments

Using the below method all online payment logs can be retrieved

curl --request GET \
  --url https://api.servetel.in/v1/billing/payments/online \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Query parameters

Variable Name

Description

Data Type

to_date

Date till which logs need to be fetched
Format: Y-m-d H:i:s

String

from_date

Date from which logs need to be fetched
Format: Y-m-d H:i:s

String

amount

Amount paid

String

operator

Qualifier for amount.
> : Greater than
< : Smaller than
>= : Greater than and equal to.
<= : Smaller than ans equal to.
<> : Not equal to

String

Get all offline payment

Using the below method all online payment logs can be retrieved

curl --request GET \
  --url https://api.servetel.in/v1/billing/payments/offline \
  --header 'accept: application/json' \
  --header 'authorization: Bearer yourtokenhere'

Query parameters

Variable Name

Description

Data Type

to_date

Date till which logs need to be fetched
Format: Y-m-d H:i:s

String

from_date

Date from which logs need to be fetched
Format: Y-m-d H:i:s

String

amount

Amount paid

String

operator

Qualifier for amount.
> : Greater than
< : Smaller than
>= : Greater than and equal to.
<= : Smaller than ans equal to.
<> : Not equal to

String

Response variables [Online/Offline payments]

Variable Name

Description

Data Type

id

Unique ID of payment

String

amount_paid

Amount paid

String

payment_id

Unique payment ID

String

created_at

Date -time of payment

String

created_at

Date -time of payment

String

payment_gateway

Payment gateway name

String

status

Status of payment
[ success, pending ]

String

amount_added

Amount added in account

Integer

amount_tax

Tax paid for payment

Integer

Online Payment

[
    {
        "id": 1,
        "amount_added": 0.00,
        "amount_tax": 0.00,
        "amount_paid": "0.00",
        "payment_id": "xxxx...xxxx",
        "gateway": "xxxx...xxxx",
        "status": "success",
        "created_at": "01-Feb-2019 15:23:27"
    },
    {
        "id": 2,
        "amount_added": 0.00,
        "amount_tax": 0.00,
        "amount_paid": "0.00",
        "payment_id": "xxxx...xxxx",
        "gateway": "xxxx...xxxx",
        "status": "pending",
        "created_at": "01-Feb-2019 15:22:24"
    }
]

Offline Payment

[
    {
        "id": 1,
        "amount_added": 0.00,
        "amount_tax": 0.00,
        "amount_paid": 0,
        "status": "Success",
        "created_at": "01-Feb-2019 00:00:00",
        "comment": "xxx...xxx",
        "type": "Manual Payment"
    },
    {
        "id": 2,
        "amount_added": 0.00,
        "amount_tax": 0.00,
        "amount_paid": 0,
        "status": "Success",
        "created_at": "01-Feb-2019 00:00:000",
        "comment": "xx...xxx",
        "type": "Manual Payment"
    }
]

🚧

Fields that can be empty

payment_id : Empty if payment is pendng
gateway : is present in case of online payment