Cancel a payout that was not submitted yet

POST

/v1/payouts/{payout_id}/cancel

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.feitpay.com/v1/payouts/example/cancel"

  req, _ := http.NewRequest("POST", url, nil)

  req.Header.Add("Gryphem-Environment", "test")
  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.feitpay.com/v1/payouts/example/cancel';
const options = {
  method: 'POST',
  headers: {'Gryphem-Environment': 'test', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.feitpay.com/v1/payouts/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Gryphem-Environment: test'

Returns the held amount to the available balance.

Authorizations

ApiKey
Session

Parameters

Path Parameters

payout_id

required

string

Header Parameters

Gryphem-Organization

string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Gryphem-Environment

string

default: test

Allowed values: test live

test (default) or live for dashboard sessions. API keys determine the environment.

Responses

200

Canceled.

application/json

object

required

string

object

required

string

Allowed value: payout

livemode

required

boolean

asset

required

string

amount

required

Decimal string. Never a float.

string

/^(0|[1-9][0-9]*)(\.[0-9]+)?$/

amount_units

required

Integer amount in the asset’s smallest unit.

string

/^[0-9]+$/

divisibility

required

integer

destination_id

required

string

destination_address

required

string

status

required

Pending_approval (waiting for a second merchant member) → pending_operator (GRYPHEM review) → submitting → submitted (created in Bitcart) → sent (broadcast) → complete (confirmed). Terminal: rejected, canceled, failed.

string

Allowed values: pending_approval pending_operator submitting submitted sent complete rejected canceled failed

note

required

string

requested_by

required

string

requested_via

required

string

Allowed values: session api_key

approved_by

required

string | null

approved_at

required

string | null format: date-time

reviewed_at

required

string | null format: date-time

review_note

required

string | null

processor

required

bitcart: sent by the platform Bitcart hot wallet (live).

string

Allowed values: bitcart simulator

processor_payout_id

required

string | null

processor_status

required

string | null

tx_hash

required

string | null

network_fee

required

string | null

failure_reason

required

string | null

funds_released

required

The held amount went back to the available balance (always for canceled and rejected payouts; for a failed payout only when nothing can have been sent, or after an operator verified that and released it).

boolean

created_at

required

string format: date-time

updated_at

required

string format: date-time

org_id

Operator console only.

string

org_name

Operator console only.

string

operator_id

string | null

Example

{
  "object": "payout",
  "amount": "59.90",
  "amount_units": "99834",
  "status": "pending_approval",
  "requested_via": "session",
  "processor": "bitcart"
}

401

Missing or invalid credentials.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

Resource not found (or not visible to this tenant).

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

409

State conflict.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Too many requests. See Retry-After.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Retry-After

integer