List all project transactions

get
List all project transactions 
https://business-sandbox.cryptopay.me/api/transactions
This endpoint allows you to list all transactions per project.
Request
Response
Request
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
Query Parameters
customer_id
optional
string
The reference ID of your customer. See Customer section on the left for more information
created_at_from
optional
string
Date and time in iso8601 format, e.g. 2019-11-10T16:56:19+00:00
created_at_to
optional
string
Date and time in iso8601 format, e.g. 2019-11-12T16:56:19+00:00
reference_type
optional
string
Transaction reference type, e.g. invoice. Please refer to a list of TX types and statuses below
currency
optional
string
Transaction currency, e.g. EUR. Please refer to a list of supported currencies
status
optional
string
Transaction status, e.g. completed. Please refer to the list of TX types and statuses below 
risk_level
optional
string
Transaction risk level. Please refer to a Risks section
starting_after
optional
string
Pagination. Transaction ID to start from
Response
200: OK
{
  "data": [
    {
      "id": "23fdf772-51a4-4448-9783-e8ab76f4f530",
      "custom_id": null,
      "amount": "198.0",
      "currency": "EUR",
      "balance": "9677.25",
      "fee": "2.0",
      "fee_currency": "EUR",
      "reference_id": "8c36b469-babb-4bf2-9bc6-84e204a83d54",
      "reference_type": "Invoice",
      "description": null,
      "status": "completed",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T16:56:03+00:00"
    },
    {
      "id": "5add276d-ba55-4c90-8a67-0d57c682f3ca",
      "custom_id": null,
      "amount": "-1.14763712",
      "currency": "ETH",
      "balance": "11977.42853463",
      "fee": "0.0",
      "fee_currency": "ETH",
      "reference_id": "7fbb10d2-53ed-445e-8899-2ff192669ed6",
      "reference_type": "CoinWithdrawal",
      "description": null,
      "status": "failed",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T16:46:10+00:00"
    },
    {
      "id": "008737f7-8196-44aa-b7a5-e5ea713fbb7d",
      "custom_id": null,
      "amount": "198.0",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "2.0",
      "fee_currency": "EUR",
      "reference_id": "e9ef0a0f-470f-4507-b522-98b527a5db26",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T16:45:28+00:00"
    },
    {
      "id": "922509f8-1c8b-411f-843e-ebdacef004d8",
      "custom_id": null,
      "amount": "9.9",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "0.1",
      "fee_currency": "EUR",
      "reference_id": "e7b81a1b-5142-4fc5-a34f-a64790369e61",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T16:00:36+00:00"
    },
    {
      "id": "279fe1d4-4eff-4998-b028-932c1d3511a4",
      "custom_id": null,
      "amount": "9.9",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "0.1",
      "fee_currency": "EUR",
      "reference_id": "824721f9-a43a-4d98-94b3-267191a22715",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T16:00:12+00:00"
    },
    {
      "id": "9cae9f47-fce1-4e01-b1d6-09d36231190d",
      "custom_id": null,
      "amount": "9.9",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "0.1",
      "fee_currency": "EUR",
      "reference_id": "b6e5cfc2-18ba-4381-90ba-66b7d7e70aaf",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T15:59:21+00:00"
    },
    {
      "id": "e832d088-9cbe-4e39-b3e4-3feb2791bebf",
      "custom_id": null,
      "amount": "9.9",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "0.1",
      "fee_currency": "EUR",
      "reference_id": "749daa98-5729-42da-bc06-29a77da73873",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T15:58:53+00:00"
    },
    {
      "id": "e6cd0ce3-b3fb-4148-8c49-bc326ed60cae",
      "custom_id": null,
      "amount": "9.9",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "0.1",
      "fee_currency": "EUR",
      "reference_id": "bac3845a-0a1e-4635-8e6e-92b03762d1aa",
      "reference_type": "Invoice",
      "description": null,
      "status": "new",
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T15:58:06+00:00"
    },
    {
      "id": "b40dac67-ac6c-4679-add2-e2bd0891e86c",
      "custom_id": null,
      "amount": "992.33",
      "currency": "EUR",
      "balance": "9479.25",
      "fee": "10.03",
      "fee_currency": "EUR",
      "reference_id": "0484fd9f-d3f9-4885-ac1d-b9d72f36fb21",
      "reference_type": "ExchangeTransfer",
      "description": null,
      "status": null,
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T15:37:18+00:00"
    },
    {
      "id": "904478c1-0baf-4186-95d6-06a7b71717c4",
      "custom_id": null,
      "amount": "-0.123",
      "currency": "BTC",
      "balance": "4.53247741",
      "fee": "10.03",
      "fee_currency": "EUR",
      "reference_id": "0484fd9f-d3f9-4885-ac1d-b9d72f36fb21",
      "reference_type": "ExchangeTransfer",
      "description": null,
      "status": null,
      "status_context": null,
      "risk": null,
      "created_at": "2019-11-12T15:37:18+00:00"
    }
  ],
  "meta": {
    "total": 10,
    "has_more": false
  }
}
API call example.
curl "https://business-sandbox.cryptopay.me/api/transactions?created_at_from=2019-11-10T16:56:19%2B00:00&created_at_to=2019-11-12T16:56:19%2B00:00" \
     -H 'Authorization: HMAC ***' \
     -H 'Content-Type: application/json' \
     -H 'Date: Thu, 14 Nov 2019 12:21:30 GMT'
Response schema.
Parameter
Type
Description
id
string
Cryptopay internal transaction ID
custom_id
string
Transaction reference ID in your system
amount
string
Transaction amount
currency
string
Transaction currency. Please refer to the list of supported currencies​
balance
string
Account balance (subtotal)
fee
string
Fee charged
fee_currency
string
Fee currency
reference_id
string
Cryptopay transaction reference id
reference_type
string
Transaction reference type. Please refer to a list of TX types and statuses below
status
string
Transaction status
status_context
string
Status context. Please refer to the Invoice statuses list​
description
string
Transaction description
risk
object
Transaction risk details. Please refer to a Risks section
score
number
Risk score
level
string
Risk level
resource_name
string
A resource name the transaction is connected to
resource_category
string
A resource category the transaction is connected to
created_at
string
Transaction creation date and time
Reference types and Statuses
Reference type
Status
Description
Invoice
new
Transaction created
​
completed
Transaction paid and settled
​
unresolved
Wrong cryptocurrency TX amount received and the invoice must be resolved
​
refunded
The whole cryptocurrency TX amount refunded to merchant account or back to customer
​
cancelled
Invoice hasn't been paid or cryptocurrency TX hasn't been confirmed within 14 days
InvoiceRefund
null
Full or partial invoice refund to the merchant's account
ChannelPayment
pending
Transaction created
​
completed
Transaction confirmed and settled
CoinWithdrawal
new
Transaction created
​
pending
Transaction needs to be committed
​
processing
Transaction is being processed
​
completed
Transaction processed and a cryptocurrency transaction sent
​
on_hold
Transaction put on hold
​
failed
Transaction failed
​
cancelled
Transaction cancelled and debited amount refunded back to the merchant account balance
CoinDeposit
pending
Transaction created
​
completed
Transaction completed and settled
ExchangeTransfer
null
N/a
BankDeposit
processing
Transaction created
​
completed
Transaction completed and settled
​
on_hold
Transaction put on hold
​
cancelled
Transaction cancelled and the transfer amount sent back to a bank account
BankWithdrawal
processing
Transaction created
​
completed
Transaction completed and sent
​
on_hold
Transaction put on hold
​
cancelled
Transaction cancelled and debited amount refunded back to the merchant account balance
Manual
null
Manual account balance transaction

REFERENCE - Previous

Transactions

Next - v2 [DEPRECATED]

Invoices

Last updated 3 weeks ago

Parameter	Type	Description
id	string	Cryptopay internal transaction ID
custom_id	string	Transaction reference ID in your system
amount	string	Transaction amount
currency	string	Transaction currency. Please refer to the list of supported currencies
balance	string	Account balance (subtotal)
fee	string	Fee charged
fee_currency	string	Fee currency
reference_id	string	Cryptopay transaction reference id
reference_type	string	Transaction reference type. Please refer to a list of TX types and statuses below
status	string	Transaction status
status_context	string	Status context. Please refer to the Invoice statuses list
description	string	Transaction description
risk	object	Transaction risk details. Please refer to a Risks section
score	number	Risk score
level	string	Risk level
resource_name	string	A resource name the transaction is connected to
resource_category	string	A resource category the transaction is connected to
created_at	string	Transaction creation date and time

Reference type	Status	Description
Invoice	new	Transaction created
	completed	Transaction paid and settled
	unresolved	Wrong cryptocurrency TX amount received and the invoice must be resolved
	refunded	The whole cryptocurrency TX amount refunded to merchant account or back to customer
	cancelled	Invoice hasn't been paid or cryptocurrency TX hasn't been confirmed within 14 days
InvoiceRefund	null	Full or partial invoice refund to the merchant's account
ChannelPayment	pending	Transaction created
	completed	Transaction confirmed and settled
CoinWithdrawal	new	Transaction created
	pending	Transaction needs to be committed
	processing	Transaction is being processed
	completed	Transaction processed and a cryptocurrency transaction sent
	on_hold	Transaction put on hold
	failed	Transaction failed
	cancelled	Transaction cancelled and debited amount refunded back to the merchant account balance
CoinDeposit	pending	Transaction created
	completed	Transaction completed and settled
ExchangeTransfer	null	N/a
BankDeposit	processing	Transaction created
	completed	Transaction completed and settled
	on_hold	Transaction put on hold
	cancelled	Transaction cancelled and the transfer amount sent back to a bank account
BankWithdrawal	processing	Transaction created
	completed	Transaction completed and sent
	on_hold	Transaction put on hold
	cancelled	Transaction cancelled and debited amount refunded back to the merchant account balance
Manual	null	Manual account balance transaction

List all project transactions

getList all project transactions

Reference types and Statuses

get
List all project transactions