CAcardda
Refund request

Create a refund request

Creates a refund request for a user. The caller must have the companies_manage permission in a company the target user (user_id) belongs to.

On creation a confirmation token is generated server-side; the target user then confirms the request by email before it is processed.

post/v1/refund_requests

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/refund_requests
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1bills/get/parameters/0 (unresolved $ref)

Request body

user_idstring required

Id of the user who will receive the refund.

amountinteger

Amount to refund, in the smallest currency unit.

statusstring
status_reasonstring
reasonstring

Example request

{
  "amount": 50000,
  "status": "pending",
  "reason": "Saldo no utilizado"
}

Response

The created refund request.

idstring uuid required
user_idstring required

Id of the user who will receive the refund.

amountinteger nullable

Amount to refund, in the smallest currency unit.

statusstring nullable
status_reasonstring nullable
reasonstring nullable
email_confirmedboolean

Whether the target user has confirmed the request via the emailed token.

created_atstring date-time
updated_atstring date-time

Example response

{
  "amount": 50000,
  "status": "pending",
  "reason": "Saldo no utilizado"
}

Changes

No recorded changes to this operation across all 1 revision of this API.