Cancel Collections Transaction - Cedar Partners API

Request

Path Params

id

string

required

The ID of the end-to-end transaction

Example:

1

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 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

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

Any of

Bank Details

null

accountNumber

string

required

The deposit bank account number

nameOnAccount

string

required

The name of the deposit bank account

bankName

string

required

The deposit bank name

bankAddress

string

required

The deposit bank full address

reference

string

required

The deposit reference number

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