Schedule a statement generation.

POST

/company_statements/

With this request, you can schedule a statement generation for a company.

In a response, you will get an object with the following structure. Main fields to look out for here are id, status and download_url.

Authorization

ApiKey

headerAuthorizationBearer <token>

Your API key from the Developers section of your account, sent as a bearer token.

Query Parameters

from?integer

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

to?integer

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

paid_from?integer

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

paid_to?integer

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

updated_from?integer

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

updated_to?integer

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

brand_id?string

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

Formatuuid

shop_id?string

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

Formatuuid

q?string

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

Formatstring

products?string

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

Formatstring

total?string

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

Formatfloat

currency?string

Filter result set to only include specified currency(ies)

payment_method?string

Filter result set to only include specified payment methods(s). See PaymentMethod fro more information.

Value in"american_express""capitec_pay""capitec_pay_recurring""debicheck""diners_club""eft""flutterwave_bank_transfer""flutterwave_ussd_charge""flutterwave_voucher_payment""hub2""maestro""mastercard""moniepoint""moniepoint_offline""moniepoint_voucher""mono""mtnmomo""onegate_eft_redirect""onevoucher""ozow""pay_at""paystack_payouts""paystack_ussd""realpay_eft""realpay_endo""stitch""unknown""visa""zapper"

three_d_secure?string

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

Formatbool

country?string

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

FormatISO 3166-1 alpha-2

status?string

Filter result set to only include results with a specific status. See Purchase and Payout for more information.

Formatstring

product?string

Filter result set to only include specified products(s). See TransactionProduct fro more information.

Value in"bank_payment""chargeback""chargeback_reversal""custom_payment""invoice""payout""payout_balance_transfer""purchase""refund""subscription"

Request Body

application/json

body

format?string

Statement format, available formats: csv, xlsx.

Lengthlength <= 32

timezone?string

Timezone to localize statement-specific timestamps

FormatTZ database name

Response Body

application/json

response

format?string

Statement format, available formats: csv, xlsx.

Lengthlength <= 32

timezone?string

Timezone to localize statement-specific timestamps

FormatTZ database name

is_test?boolean

Indicates this is a test object, created using test API keys or using Billing section of UI while in test mode.

company_uid?string

ID of the Company.

Formatuuid

query_string?string

Query parameters used to generate statement.

status?string

Status of statement generation e.g. pending, processing, success.

download_url?string

Download URL of a statement.

began_on?integer

Date and time for the beginning of statement generation process.

FormatUnix timestamp (seconds)

finished_on?integer

Date and time for finishing the statement generation process.

FormatUnix timestamp (seconds)

created_on?integer

Object creation time

FormatUnix timestamp (seconds)

updated_on?integer

Object last modification time

FormatUnix timestamp (seconds)

type?string

Statement request type

id?string

ID of a statement

Formatuuid

Example Request

curl -X POST 'https://gate.reviopay.com/api/v1/company_statements/' \  -H 'Content-Type: application/json' \  -d '{  "format": "csv",  "timezone": "UTC"}'

Example ResponseSchema

{  "format": "string",  "timezone": "Europe/Oslo",  "is_test": true,  "company_uid": "1b37ed80-aa86-439a-a1c4-9db2cd6f47e6",  "query_string": "string",  "status": "string",  "download_url": "string",  "began_on": 1619740800,  "finished_on": 1619740800,  "created_on": 1619740800,  "updated_on": 1619740800,  "type": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

POST

/company_statements/

With this request, you can schedule a statement generation for a company.

In a response, you will get an object with the following structure. Main fields to look out for here are id, status and download_url.

Authorization

ApiKey

headerAuthorizationBearer <token>

Your API key from the Developers section of your account, sent as a bearer token.

Query Parameters

from?integer

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

to?integer

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

paid_from?integer

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

paid_to?integer

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

updated_from?integer

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

updated_to?integer

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

brand_id?string

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

Formatuuid

shop_id?string

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

Formatuuid

q?string

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

Formatstring

products?string

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

Formatstring

total?string

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

Formatfloat

currency?string

Filter result set to only include specified currency(ies)

payment_method?string

Filter result set to only include specified payment methods(s). See PaymentMethod fro more information.

three_d_secure?string

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

Formatbool

country?string

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

FormatISO 3166-1 alpha-2

status?string

Filter result set to only include results with a specific status. See Purchase and Payout for more information.

Formatstring

product?string

Filter result set to only include specified products(s). See TransactionProduct fro more information.

Value in"bank_payment""chargeback""chargeback_reversal""custom_payment""invoice""payout""payout_balance_transfer""purchase""refund""subscription"

Request Body

application/json

body

format?string

Statement format, available formats: csv, xlsx.

Lengthlength <= 32

timezone?string

Timezone to localize statement-specific timestamps

FormatTZ database name

Response Body

application/json

response

format?string

Statement format, available formats: csv, xlsx.

Lengthlength <= 32

timezone?string

Timezone to localize statement-specific timestamps

FormatTZ database name

is_test?boolean

Indicates this is a test object, created using test API keys or using Billing section of UI while in test mode.

company_uid?string

ID of the Company.

Formatuuid

query_string?string

Query parameters used to generate statement.

status?string

Status of statement generation e.g. pending, processing, success.

download_url?string

Download URL of a statement.

began_on?integer

Date and time for the beginning of statement generation process.

FormatUnix timestamp (seconds)

finished_on?integer

Date and time for finishing the statement generation process.

FormatUnix timestamp (seconds)

created_on?integer

Object creation time

FormatUnix timestamp (seconds)

updated_on?integer

Object last modification time

FormatUnix timestamp (seconds)

type?string

Statement request type

id?string

ID of a statement

Formatuuid

Example Request

curl -X POST 'https://gate.reviopay.com/api/v1/company_statements/' \
  -H 'Content-Type: application/json' \
  -d '{
  "format": "csv",
  "timezone": "UTC"
}'

Example Request

curl -X POST 'https://gate.reviopay.com/api/v1/company_statements/' \  -H 'Content-Type: application/json' \  -d '{  "format": "csv",  "timezone": "UTC"}'

Example ResponseSchema

{
  "format": "string",
  "timezone": "Europe/Oslo",
  "is_test": true,
  "company_uid": "1b37ed80-aa86-439a-a1c4-9db2cd6f47e6",
  "query_string": "string",
  "status": "string",
  "download_url": "string",
  "began_on": 1619740800,
  "finished_on": 1619740800,
  "created_on": 1619740800,
  "updated_on": 1619740800,
  "type": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

{  "format": "string",  "timezone": "Europe/Oslo",  "is_test": true,  "company_uid": "1b37ed80-aa86-439a-a1c4-9db2cd6f47e6",  "query_string": "string",  "status": "string",  "download_url": "string",  "began_on": 1619740800,  "finished_on": 1619740800,  "created_on": 1619740800,  "updated_on": 1619740800,  "type": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

Schedule a statement generation.

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Schedule a statement generation.

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Request Body

Response Body

Authorization

Query Parameters

Request Body

Response Body