Skip to content
ParaSta Docs

Cancel a Payment

POST
/v1/payments/{id}/cancel
 
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

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Payment canceled

Media type application/json
object
id
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; krw = exchange to KRW at confirmation; splits = mixed

string
Allowed values: coin krw splits
krw_account

Required when mode=krw

string
splits
Array<object>
object
destination
required
string
Allowed values: coin krw
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",
    "splits": [
      {
        "destination": "coin"
      }
    ]
  }
}

404

Section titled “404 ”

Object not found

Media type 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

Section titled “409 ”

Payment is not cancelable

Media type 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"
  }
}