One payment, by its id

GET

/v1/payments/{id}

const url = 'https://api.sotirea.com/v1/payments/example';
const options = {method: 'GET', 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 GET \
  --url https://api.sotirea.com/v1/payments/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

required

string

The payment’s id, as sending it answered: api::.

Responses

200

Done.

application/json

object

data

required

object

amount

required

In the asset’s smallest unit.

string

approvals_given

required

integer

approvals_required

required

How many people must agree before it is sent; 0 when it needs no approval.

integer

asset

required

string

chain_id

required

string

chain_name

required

string

created_at

required

string format: date-time

decimals

required

Any of:

integer
null

integer

error

required

Any of:

string
null

string

from

required

string

held_by

required

Any of:

string
null

string

required

The payment’s id: api::.

string

paused

required

The network or asset is not available right now: a payment waiting cannot be approved or sent until it is. One already sent is still followed to the end.

boolean

purpose

required

Payment, asked for by a person or a key; or sweep, sent by one of your sweep rules from a deposit vault into one of your own vaults.

string

recognised

required

True for the network’s coin and for tokens on Sotirea’s recognised list. Any other token’s symbol is whatever its contract calls itself, so do not trust it by name.

boolean

reference

required

Any of:

string
null

string

requested_by_name

required

string

sent_at

required

Any of:

string
null

string format: date-time

settled_at

required

Any of:

string
null

string format: date-time

status

required

Requested, awaiting_approval, awaiting_gas, signed, sent, confirmed, failed or stuck. New statuses may be added: treat one you do not know as still in progress.

string

symbol

required

string

required

string

tx_hash

required

Any of:

string
null

string

vault_id

required

Any of:

integer
null

integer

vault_name

required

string

meta

object

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

application/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}