Cancel Collections Transaction

Live Partners API

https://partners-api.service.cedar.money/bpapi

POST

/v1/receive/cancel/{id}

Cancel collections transaction by its ID. Cancellation is not available once the transaction has been processed.

Request

Path Params

Header Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partners-api.service.cedar.money/bpapi/v1/receive/cancel/1' \
--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

Example

{
    "businessRequestId": 1,
    "creationTime": 1741253004225,
    "lastUpdateTime": 1741253579459,
    "toAmount": "100000.0",
    "fromAmount": "160881501.15",
    "purpose": "GOODS_PURCHASED",
    "quoteApprovedDate": 1741253321781,
    "depositApprovedDate": 1741253579459,
    "depositReceivedDate": 1741253579459,
    "depositReceivedAmount": "160881501.15",
    "payout": null,
    "fromCurrencySymbol": "NGN",
    "toCurrencySymbol": "USD",
    "fromBusinessId": 1,
    "toBusinessExternalAccountId": 2,
    "toBusinessId": 2,
    "clientStatus": "Receive_CANCELED",
    "bankDetails": {
        "bankName": "Test Bank",
        "accountNumber": "1234567890",
        "reference": "Test Reference",
        "bankAddress": "123 Test St",
        "nameOnAccount": "Test Name"
    }
}

🟠400Error

Modified at 2025-06-15 12:52:00

Approve Collections Transaction Deposit

Get Payout Confirmation by Transaction ID