Update offer credit amount

Updates the credit amount on an offer. The offer must be in “pending” or “awaiting_customer” status.

POST/{id}/credit

Authorization

AuthorizationBearer token · headerrequired

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Scopes:write:offers

Path parameters

idstringrequired

The ID of the offer to update

Request body

application/json

creditAmountintegerrequired

Credit amount in cents (e.g., 10000 = $100.00). Must be a non-negative integer.

min 0

Responses

200

Offer credit amount updated successfully

successbooleanrequired

Whether the credit amount was updated successfully

creditAmountintegerrequired

The credit amount that was persisted, in cents. Callers should verify this matches their request.

min 0

updatedAtstring<date-time>required

Timestamp when the credit amount was updated

400

Bad request - Offer credit could not be updated

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

401

Unauthorized - Missing or invalid authentication

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

403

Forbidden - Caller can view this offer but is not allowed to update it

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

404

Not found - Offer does not exist or caller is not allowed to view it

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

500

Internal server error

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

Request

curl -X POST 'https://api.sibipro.com/prod/offers/string/credit' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "creditAmount": 10000
}'

const response = await fetch("https://api.sibipro.com/prod/offers/string/credit", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"creditAmount\": 10000\n}"
});

Response

{
  "success": true,
  "creditAmount": 10000,
  "updatedAt": "2024-01-20T12:00:00Z"
}

{
  "code": "OFFER_CREDIT_NOT_ALLOWED",
  "message": "Offer credit cannot be updated because it is in \"canceled\" status"
}

{
  "code": "UPDATE_CREDIT_AMOUNT_ERROR",
  "message": "Failed to update offer credit amount"
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing authentication token"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "The presented token is missing the `write:offers` scope, which this endpoint requires. Create a token with the scopes you need at https://developer.sibipro.com."
}

{
  "code": "FORBIDDEN",
  "message": "User does not have permission to update this offer"
}

{
  "code": "OFFER_NOT_FOUND",
  "message": "Offer not found"
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred"
}