Cancel a Payment

POST

/v1/payments/{id}/cancel

const url = 'https://api.parasta.io/v1/payments/example/cancel';
const options = {method: 'POST', headers: {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.parasta.io/v1/payments/example/cancel \
  --header 'Authorization: Bearer <token>'

Cancels an unpaid payment. Returns 409 if already in a terminal state.

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Responses

200

Payment canceled

application/json

object

required

string

amount

required

Smallest unit

integer format: int64

currency

required

string

Allowed values: USDT USDC ETH SOL

network

required

string

Allowed values: POLYGON ETHEREUM SOLANA

status

required

string

Allowed values: pending processing succeeded failed expired canceled

pay_address

required

string

expires_at

required

string format: date-time

settlement

object

mode

required

Coin = keep crypto; fiat = exchange to fiat (USD/KRW/IDR) at confirmation; splits = mixed

string

Allowed values: coin fiat splits

fiat

Required when mode=fiat. Selects the fiat currency and the destination bank account.

object

currency

required

string

Allowed values: USD KRW IDR

account

required

Bank account ID for the chosen fiat currency

string

splits

Array<object>

object

destination

required

string

Allowed values: coin fiat

fiat

Required when destination=fiat.

object

currency

required

string

Allowed values: USD KRW IDR

account

required

string

percent

required

number

<= 100

metadata

object

key

additional properties

string

created

string format: date-time

Example

{
  "id": "pi_abc123",
  "currency": "USDT",
  "network": "POLYGON",
  "status": "pending",
  "pay_address": "0x1234...abcd",
  "settlement": {
    "mode": "coin",
    "fiat": {
      "currency": "USD",
      "account": "kacct_abc123"
    },
    "splits": [
      {
        "destination": "coin",
        "fiat": {
          "currency": "USD"
        }
      }
    ]
  }
}

404

Object not found

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error not_found_error rate_limit_error idempotency_error payment_error network_error api_error

code

required

string

message

required

string

param

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error"
  }
}

409

Payment is not cancelable

application/json

object

error

required

object

type

required

string

Allowed values: authentication_error permission_error invalid_request_error not_found_error rate_limit_error idempotency_error payment_error network_error api_error

code

required

string

message

required

string

param

string

request_id

string

Example

{
  "error": {
    "type": "authentication_error"
  }
}