Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

OAuth2 client_credentials authorization. Obtain a new access_token when it expires.

Body

application/json

Request parameters.

merchant_id
string
required

Business identifier assigned by BillBuddy.

Required string length: 1 - 20
merchant_order_no
string[]
required

Merchant order numbers to cancel: 1 to 100 items. Each item is a required string of at most 60 characters. Duplicates are deduplicated.

Required array length: 1 - 100 elements

Merchant order number to cancel. Required string of at most 60 characters; cannot be null, empty or whitespace-only.

Required string length: 1 - 60
Pattern: \S

Response

HTTP 200. Distinguish success, business errors, validation errors and business authentication errors using the response body code.

Success response.

code
enum<integer>
required

0 means cancellation request processing is complete. Check each cancelled/skipped result.

Available options:
0
message
string
required

Response message.

data
object
required

Processing summary.