Cancel Collections Transaction

Live Partners API

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

POST

/v1/receive/cancel/{id}

Calculate the amount required to deposit and the conversion rate in order to send the payout amount.

Request

Path Params

Header Params

Body Params application/json

Example

{
    "reason": "WRONG_PAYMENT_AMOUNT",
    "otherReason": "Other Reason"
}

Request Code 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/' \
--header 'x-api-key: CEDAR_DEV_api_key_b0ab5b29-caa7-4fa6-9f94-51dbc145e9ed' \
--header 'x-api-secret: CEDAR_DEV_api_secret_YtGc1iMIdVaSlE3yeBxS3Y6RY3j933s3YdTloLZjY9ar7T5vuVTGPovoRplo7PSZbYg2RLV9yJ3ZT7BctcxxPSR5pQpEMndj3EJB' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason": "WRONG_PAYMENT_AMOUNT",
    "otherReason": "Other Reason"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "businessRequestId": 1,
    "creationTime": 1741020401272,
    "lastUpdateTime": 1741020401272,
    "toAmount": "100000.0",
    "fromAmount": null,
    "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_CANCELED",
    "payoutStatus": "NONE",
    "cancelReason": "WRONG_PAYMENT_AMOUNT",
    "bankDetails": null
}

🟠400Error

Modified at 2026-01-25 13:50:07

Approve Collections Transaction Deposit

Get Payout Confirmation by Transaction ID