Cancel a payment
curl --request POST \ --url https://api.b-paid.com/v1/payments/BPT-000000-000001-00/cancel \ --header 'X-Api-Key: <X-Api-Key>'Cancels a scheduled payment you sent. You can cancel a payment only while its status is scheduled. The amount is returned to your available balance. Canceling a payment that is already canceled returns it unchanged.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The payment’s id.
Example
BPT-000000-000001-00Responses
Section titled “Responses”The payment.
A payment between your account and another b-paid account, sent or received.
object
Unique identifier for the payment. The b-paid app shows it as the payment’s reference number. Treat it as an opaque string.
Where the payment stands.
pending: The payment is being processed. The money may already have moved. A payment with a due date ispendingwhile it is being paid, and can bependingbriefly before it isscheduled. It can be canceled only once it isscheduled.scheduled: The payment is waiting for its due date. The amount is set aside from the sender’s available balance.complete: The payment has been paid. This is final.failed: The payment was not paid, for example because the sender’s available balance was too low, or because by the due date one of the accounts could no longer send or receive payments. Any amount set aside is returned to the sender’s available balance. To find out why a payment failed, contact b-paid support with itsid. This is final.canceled: The sender canceled the scheduled payment. The amount is returned to the sender’s available balance. This is final.
The payment amount in cents (USD), as created. It never changes.
The amount paid in cents (USD), once the payment is complete; null until then. If the recipient accepted quick pay, this is amount minus the discount.
The bpid of the account that sends the payment.
The bpid of the account that receives the payment.
The number of days from creation to the due date. null for a payment made now.
The quick pay discount, in percent, offered to the recipient for being paid before the due date. null if none was offered.
The ISO 8601 date and time at which the payment is due. The payment is made shortly after this time. null for a payment made now. A payment the recipient accepted early with quick pay keeps its original scheduled_for.
The ISO 8601 date and time at which the payment was created.
Example
{ "id": "BPT-000000-000001-00", "status": "canceled", "amount": 145000, "amount_paid": null, "source_account_id": "ACC-ONE-000-BZ", "destination_account_id": "SIM-PAY-002-BZ", "net_terms_days": 30, "quick_pay_percent": 2.5, "scheduled_for": "2026-10-22T17:42:08.1234567Z", "created_at": "2026-09-22T17:42:08.1234567Z"}A query parameter is unknown, empty or repeated (invalid_parameters_error).
The API key is missing, unknown or revoked (invalid_api_key_error).
API access isn’t turned on for your account (insufficient_permissions_error); b-paid support can turn it on. Or your business isn’t verified yet (verification_required_error); finish verifying it in the b-paid app.
No payment with this id was sent to or from your account (object_not_found_error).
The payment can’t be canceled (invalid_operation_error). Only the sender can cancel a payment, and only while its status is scheduled.
Too many requests (rate_limited_error). Wait the number of seconds in the Retry-After header, then retry.
Headers
Section titled “Headers”Seconds to wait before retrying.
Something went wrong on our side (internal_server_error). Retry the same request.
The b-paid API is temporarily unavailable (service_unavailable_error). Retry the same request in a moment.