Show a payment (by custom_id)

get
Show a payment by its custom_id

https://business-sandbox.cryptopay.me/api/coin_withdrawals/custom_id/:custom_id
This endpoint allows you to show payment details by its custom_id.
Request
Response
Path Parameters
custom_id
required
string
Coin withdrawal custom_id
Headers
Authorization
required
string
HMAC using API key and signature
Content-Type
required
string
application/json
Date
required
string
Current date in HTTP-date format
200: OK
{
"id": "f04d3cac-837a-4245-840d-1b525a4d693d",
"custom_id": "113562013",
"address": "2MyYeAkU162aMh3otEhYHP9yhUR7xqS7S1r",
"txid": "7c1b29ae5bd337f62a0f18d6e2d6123430b3120e990869ee3e0b9bd2008678c4",
"status": "completed",
"charged_amount": "10.17",
"charged_currency": "EUR",
"received_amount": "0.00103102",
"received_currency": "BTC",
"network_fee": "0.0000054",
"network_fee_level": "average",
"fee": "0.0",
"fee_currency": "BTC",
"exchange": {
"pair": "BTCEUR",
"rate": "9699.0409",
"fee": "0.11",
"fee_currency": "EUR"
},
"risk": {
"score": 0.0,
"level": "low",
"resource_name": "default",
"resource_category": "unknown"
},
"created_at": "2019-05-02T12:08:46Z"
}

Response schema.

Parameter

Type

Description

id

string

Coin withdrawal ID

custom_id

string

Payment reference ID in your system

address

string

Recipient's cryptocurrency wallet address

txid

string

Cryptocurrency transaction ID on the blockchain

status

string

Coin withdrawal status. Refer to a status list

charged_amount

string

Payment amount. Amount charged from your account

charged_currency

string

Account currency the payment has been sent from

received_amount

string

Cryptocurrency transaction amount. Exact amount received by a recipient

received_currency

string

Cryptocurrency type

network_fee

string

Network fee amount. Refer to a network fee section

network_fee_level

string

slow, average or fast

exchange

object

Exchange details

pair

string

Currency pair

rate

string

Exchange rate

fee

string

Exchange fee

fee_currency

string

Exchange fee currency

risk

object

Cryptocurrency transaction risk level details

score

number

Transaction risk score

level

string

Transaction risk level. low, medium or high depending on the score value

resource_name

string

A resource name the external wallet address relates to e.g. Bitstamp. Can be default if no data obtained

resource_category

string

A resource category the external wallet address relates to e.g. Exchange. Can be unknown if no data obtained

created_at

string

Coin withdrawal creation date and time