Paytota API
  • PAYMENTS
    • Introduction
    • Authorization
    • Webhooks
    • Account Balance
    • Mobile Money
      • Collection/Purchase
      • Disbursement/Payout
    • CARDS
      • Card Collection
    • Bank
      • Bank Payout
    • Company Statements
    • Definitions
  • USSD
    • Get Started
Powered by GitBook
On this page
  • Schedule a statement generation
  • Retrieve a statement by ID.
  1. PAYMENTS

Company Statements

Schedule a statement generation

POST {base url}/api/v1/company_statements/

This request allows you to schedule statement generation for a company. The response will include an object with fields such as id, status, and download_url. These are the key fields to focus on.

Headers

Name
Type
Description

Content-Type*

String

application/json

Authorization*

String

Bearer

Token*

String

{{secret key}}

{
  "format": "csv",
  "timezone": "UTC"
}
{
  "format": "csv",
  "timezone": "UTC",
  "is_test": false,
  "company_uid": "706d0675-b131-468c-940d-bc0ea3599e7f",
  "query_string": "",
  "status": "pending",
  "download_url": null,
  "began_on": null,
  "finished_on": null,
  "created_on": 1698322275,
  "updated_on": 1698322275,
  "type": "statement_request",
  "id": "1dd24660-527d-422a-9bfa-937c5b752eb0"
}
Name
Description

from integer(query)

Filter result set to only include values older or equal to the provided Unix timestamp

to integer(query)

Filter result set to only include values younger than the provided Unix timestamp

paid_from integer(query)

Filter paid result set to only include values older or equal to the provided Unix timestamp

paid_to integer(query)

Filter paid result set to only include values younger than the provided Unix timestamp

updated_from integer(query)

Filter result set to only include values older or equal to the provided last modification time Unix timestamp

updated_to integer(query)

Filter result set to only include values younger than the provided last modification time Unix timestamp

brand_id string($uuid)(query)

Filter result set to only include the specified brand UUID(s)

shop_id string($uuid)(query)

Filter result set to only include the specified shop UUID(s)

q string($string)(query)

Filter result set to only include results including a specified text (search over a ton of text fields)

products string($string)(query)

Filter result set to only include results including a specified text in products

total string($float)(query)

Filter result set to only include results with a total between min and max value. Must include 2 values, if any - (min, max).

currency string(query)

Filter result set to only include specified currency(ies)

payment_method string(query)

Filter result set to only include specified payment methods(s).

Available values : maestro, mastercard, unknown, visa

three_d_secure string($bool)(query)

Filter result set to only include results with a 3-D verification.

country string($ISO 3166-1 alpha-2)(query)

Filter result set to only include specified client country(ies) in ISO 3166-1 alpha-2 format

status string($string)(query)

Filter result set to only include results with a specific status.

product string(query)

Filter result set to only include specified products(s).

Available values : bank_payment, chargeback, custom_payment, invoice, payout, payout_balance_transfer, purchase, refund, subscription

Retrieve a statement by ID.

GET {base url}/api/v1/company_statements/{id}/

Headers

Name
Type
Description

Content-Type*

String

application/json

Authorization*

String

Bearer {{secret key}}

{
  "format": "csv",
  "timezone": "UTC",
  "is_test": false,
  "company_uid": "706d0675-b131-468c-940d-bc0ea3599e7f",
  "query_string": "",
  "status": "success",
  "download_url": "https://paytota-private.s3.af-south-1.amazonaws.com/706d0675-b131-468c-940d-bc0ea3599e7f/src/statement/022b9a1f-1411-4d60-b7e9-4e7daaf6903b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2DOUUV7G3EN%2F20231026%2Faf-south-1%2Fs3%2Faws4_request&X-Amz-Date=20231026T124044Z&X-Amz-pires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e7fd9eda97b07abadb9caad3f555a9a06815db541a4bec11110a87ed699d",
  "began_on": 1698322277,
  "finished_on": 1698322277,
  "created_on": 1698322275,
  "updated_on": 1698322277,
  "type": "statement_request",
  "id": "1dd24660-527d-422a-9bfa-937c5b752eb0"
}
PreviousBank PayoutNextDefinitions

Last updated 8 months ago