Get Collections Transactions with Pagination

Request

Query Params

start

integer

optional

The first row to retrieve (starts at 0)

Default:

0

Example:

0

limit

integer

optional

The number of rows to retrieve

Default:

10

Example:

10

businessId

integer

optional

Filter for specific merchant by its ID

Example:

1

fromDate

integer

optional

Filter transactions created after UNIX timestamp date

Example:

1741013991817

toDate

integer

optional

Filter transactions created before UNIX timestamp date

Example:

1742343991364

Header Params

x-api-key

string

required

Example:

CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed

x-api-secret

string

required

Example:

CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://partners-api.service.cedar.money/bpapi/v1/receive/?start=0&limit=10&businessId=1&fromDate=1741013991817&toDate=1742343991364' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB'

Responses

🟢200OK

application/json

Body

start

integer

required

The first row to retrieve (starts at 0)

limit

integer

required

The number of rows to retrieve

hasMore

boolean

required

The entity has additional rows available to retrieve (The total rows count > start + limit)

results

array[object (Collections Transaction) {18}]

required

Receiver account's array

businessRequestId

integer

required

The collections transaction's ID

creationTime

integer

required

The entity creation time in UNIX timestamp

lastUpdateTime

integer

required

The entity last update time in UNIX timestamp

toAmount

string

required

Payout amount to receiver account

fromAmount

string | null

optional

Deposit amount

purpose

enum<string>

required

Transaction's purpose

Allowed values:

GOODS_PURCHASEDPAYMENT_OF_GOODSPAYMENT_OF_SERVICESOTHER_SERVICES

quoteApprovedDate

number | null

optional

The time the quote was approved by the client in UNIX timestamp

depositApprovedDate

number | null

optional

The time the deposit was approved by the client in UNIX timestamp

depositReceivedDate

number | null

optional

The time the deposit was received in the system in UNIX timestamp

depositReceivedAmount

string | null

optional

Deposit amount received by the system

payout

string | null

optional

Payout amount sent

fromCurrencySymbol

string

required

Deposit currency

toCurrencySymbol

string

required

Payout currency

fromBusinessId

integer

required

The ID of the requesting merchant that initiated the transaction for collection of funds

toBusinessExternalAccountId

integer

required

The ID of the requesting merchant's receiver account for payout of the funds

toBusinessId

integer

required

The ID of the paying merchant, this merchant deposits the funds

clientStatus

enum<string>

required

The current status of the transaction

Allowed values:

NONEReceive_PENDINGReceive_AWAITING_QUOTE_APPROVALReceive_AWAITING_DEPOSITReceive_IN_PROGRESSReceive_COMPLETEDReceive_CANCELEDReceive_EXPIRED

bankDetails

optional

The deposit details

Example

{
    "start": 0,
    "limit": 10,
    "hasMore": false,
    "results": [
        {
            "businessRequestId": 1,
            "creationTime": 1741253004225,
            "lastUpdateTime": 1741253004225,
            "toAmount": "100000.0",
            "fromAmount": "160881501.15",
            "purpose": "GOODS_PURCHASED",
            "quoteApprovedDate": null,
            "depositApprovedDate": null,
            "depositReceivedDate": null,
            "depositReceivedAmount": null,
            "payout": null,
            "fromCurrencySymbol": "NGN",
            "toCurrencySymbol": "USD",
            "fromBusinessId": 1,
            "toBusinessExternalAccountId": 2,
            "toBusinessId": 2,
            "clientStatus": "Receive_AWAITING_QUOTE_APPROVAL",
            "bankDetails": null
        }
    ]
}

🟠400Error