Cancel Payout

Cancel Payout

POST {{Environment_URL}}/v1/payments/payouts/:payout_id/cancel

Headers

Name	Value
Authorization	Bearer <token>

Path Params

Key	Description	Required?	Data type	Example value
payout_id	payout identifier.	true	String	"f384007d-535b-465d-8302-a59e8fb24485"

Body Params

Key	Description	Required?	Data type	Example value
reason	reason for cancellation	false	String	"Admin Request"

Request Body

Cancel Payout

{
    "reason": "Admin Request"
}

Response

201 - Success

{
  "data": {
    "id": "f384007d-535b-465d-8302-a59e8fb24485",
    "accountEntityId": 584,
    "internalOperationEntityId": null,
    "externalId": "FCID1765375810591-98765",
    "idempotencyCode": null,
    "invoiceId": null,
    "payoutTransactionId": null,
    "transactionEndToEndId": null,
    "originBatchId": null,
    "type": "SIMPLE_PAY",
    "userId": 357,
    "refundedAmount": null,
    "amount": "987.65",
    "amountWithPrecision": {
      "value": 98765,
      "precision": 2
    },
    "payoutMethod": "PIX",
    "pixType": "UNKNOWN",
    "pixKey": "59552209099",
    "name": null,
    "cpf": null,
    "cnpj": null,
    "ownerDocument": "59552209099",
    "accountNumber": null,
    "branchNumber": null,
    "bankNumber": null,
    "bankName": null,
    "pspId": null,
    "status": "CANCELED",
    "subStatus": null,
    "events": [
      {
        "to": "AWAITING_QUEUE_PROCESS",
        "from": "AWAITING_QUEUE_PROCESS",
        "timestamp": "2025-12-10T14:10:10.605Z",
        "transitionName": "awaitQueueProcess"
      },
      {
        "to": "AWAITING_FUNDS",
        "from": "AWAITING_QUEUE_PROCESS",
        "metadata": {
          "reason": "PMT_ERR_406"
        },
        "timestamp": "2025-12-10T14:10:11.322Z",
        "transitionName": "awaitFunds"
      },
      {
        "from": "AWAITING_FUNDS",
        "to": "CANCELED",
        "transitionName": "cancel",
        "timestamp": "2025-12-10T14:10:46.741Z"
      }
    ],
    "proofOfPaymentUrl": null,
    "error": {
      "code": "PMT_ERR_406",
      "description": "The provider's account doesn't have enough funds.",
      "exception": {
        "balance": 555.86
      }
    },
    "accountType": null,
    "metadata": {
      "cancellationData": {
        "reason": "teste",
        "agentUser": "[email protected]"
      }
    },
    "merchant": "(Support API) - Não modificar",
    "createdAt": "2025-12-10T14:10:10.593Z",
    "updatedAt": "2025-12-10T14:10:46.743Z",
    "deletedAt": null,
    "paidIn": null,
    "account": {
      "id": 584,
      "ulid": "acc-01k83gtj94jjfz8vzz528h8vb2",
      "currency": "BRL",
      "accountHolderName": "(Support API) - Não modificar",
      "accountHash": "405513-690083-9579097-4",
      "bankAccountTaxNumber": "31625631000120",
      "bankAccountSpb": {
        "bank": "450",
        "digit": "0",
        "branch": "0001",
        "account": "208333488"
      },
      "bankAccountMain": {
        "bank": "450",
        "digit": "1",
        "branch": "001",
        "account": "8569048"
      },
      "accountPixAlias": "1b09ef71-a9f0-4703-83d9-45c9a440d054",
      "pixQRCodeChargeExpirationTimeInSeconds": 7200,
      "brokerId": "FITBANK",
      "agentId": 172,
      "currentValue": 55586,
      "minimumBalanceForPayout": 0,
      "createdAt": "2025-10-21T13:55:02.537Z",
      "updatedAt": "2025-12-10T14:10:11.341Z",
      "deletedAt": null,
      "isInternalFitbankAccount": false,
      "isLowOnFunds": true,
      "isCurrentPeriodLimitExceeded": false,
      "status": "ACTIVE",
      "mpath": null,
      "events": [
        {
          "to": "REQUESTED_TO_CREATE_IN_BROKER",
          "from": "CREATED",
          "timestamp": "2025-10-21T13:55:06.413Z",
          "transitionName": "requestBrokerCreation"
        },
        {
          "to": "CREATED_IN_BROKER",
          "from": "REQUESTED_TO_CREATE_IN_BROKER",
          "timestamp": "2025-10-22T20:30:37.584Z",
          "transitionName": "creationInBrokerCompleted"
        },
        {
          "to": "REQUESTED_TO_CREATE_PIX_KEY",
          "from": "CREATED_IN_BROKER",
          "timestamp": "2025-10-22T20:30:38.138Z",
          "transitionName": "requestPixKeyCreation"
        },
        {
          "to": "AVAILABLE",
          "from": "REQUESTED_TO_CREATE_PIX_KEY",
          "timestamp": "2025-10-23T09:48:17.575Z",
          "transitionName": "available"
        },
        {
          "to": "ACTIVE",
          "from": "AVAILABLE",
          "timestamp": "2025-12-09T17:53:26.365Z",
          "transitionName": "active"
        }
      ],
      "pixData": null
    },
    "bankData": null
  },
  "message": "Payout canceled successfully."
}