Bitcall logoBitcall API
OTP
Add your Key ID and Secret to send test requests.

Withdraw a refund request

POST
/v1/otp/refund-requests/cancel
*object

Withdraws a refund request that is still pending. Repeating the call returns the already-cancelled request. This operation is safe to repeat: repeating it returns the existing state and performs no further action.

Authorization

KeyId ApiSecret
x-key-id<token>

Your API key id.

In: header

x-api-secret<token>

Your API key secret.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/otp/refund-requests/cancel" \  -H "Content-Type: application/json" \  -d '{    "_id": "rfr_dzbrGa3sm2Gevy_0b2ukhBQJCAx4W8_oObG5CO_Wqw"  }'
{
  "data": {
    "refundRequestId": "string",
    "status": "pending",
    "amount": {
      "amount": 0,
      "currency": "string"
    },
    "reason": "string",
    "notes": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request is not valid. See `fields` for what to correct.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "AUTHENTICATION_REQUIRED",
    "message": "This endpoint requires an API key.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "No such resource.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "The resource is not in a state that allows this operation.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests. Retry after the interval in `Retry-After`.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Something went wrong on our side.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_RESPONSE_INVALID",
    "message": "The upstream service returned an unexpected response.",
    "requestId": "9f1c7b2e-…"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "The service is temporarily unavailable. Try again shortly.",
    "requestId": "9f1c7b2e-…"
  }
}

Open a refund request POST

Asks for an order to be refunded. The request starts in `pending` and is decided by Bitcall; it does not move money by itself.

List number pools GET

Returns the number pools available to you, by their public codes. A pool is a grouping of numbers, not something you can rent directly: use its code to filter [GET /v1/otp/services](#operation/listOtpServices), and rent with the `serviceId` from a catalog offer — whose first segment is this same code.