List Payouts

List Payments

GET https://api.sandbox.coindirect.com/api/v1/pay/summary?merchantId=:id

This endpoint allows you to list all payments.

Query Parameters

NameTypeDescription

offset

string

This tells us where to start fetching the records

max

string

This limits the number of records returned per page. The default is 10 records

merchantId

string

Merchant ID. You can find it on the "Merchant Details" in your business account

fromDate

string

To list payments from Date

toDate

string

To list payment to Date

status

string

Payment status filter

q

string

Can be UUID, reference, payment address or transactions hash

Headers

NameTypeDescription

Authorization

string

HAWK Token. See Authentication page

[
  {
    "uuid": "5c75bc40-c1b2-4f57-b96f-79882a6e7c4b",
    "merchantId": "9a57c17a-1eef-48ff-83d0-b5892c99f767",
    "dateCreated": 1633010030000,
    "expiryDate": 1633011226000,
    "reference": "c71102cf-4ac7-4503-8003-2e63931dd6e6",
    "type": "IN",
    "status": "COMPLETE",
    "displayCurrency": {
      "currency": "JPY",
      "amount": 1E+4,
      "actual": 1E+4
    },
    "walletCurrency": {
      "currency": "EUR",
      "amount": 77.11,
      "actual": 77.11
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.0305817,
      "actual": 0.030581700000000000
    },
    "feeCurrency": {
      "currency": "EUR",
      "amount": 0.77,
      "actual": 0.77
    },
    "displayRate": {
      "base": "ETH",
      "counter": "JPY",
      "rate": 326992.940222420597939290
    },
    "exchangeRate": {
      "base": "EUR",
      "counter": "ETH",
      "rate": 2521.442345707899981442
    },
    "address": {
      "protocol": null,
      "address": "0x6115cfe64f3a8e4d974984a22a01936343bc8156",
      "tag": null
    },
    "redirectUrl": "https://business.sandbox.coindirect.com/payin?uuid=5c75bc40-c1b2-4f57-b96f-79882a6e7c4b&flow=direct",
    "returnUrl": "https://yourwebsitename.com",
    "transactions": [
      {
        "dateCreated": 1633010180000,
        "dateConfirmed": 1633010242000,
        "hash": "0x087bcfd76ae12d6116d35a442e51dfff99e77fbf8330be39017dbdc60df7afea",
        "amount": 0.030581700000000000,
        "risk": "UNKNOWN",
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.000031500000252000,
        "sources": [
          "0x1a2e97fd13c0610239c0b1cdbb0806f35adff3f0"
        ],
        "exchangeRate": {
          "base": "EUR",
          "counter": "ETH",
          "rate": 0.000396598400000000
        },
        "displayRate": {
          "base": "ETH",
          "counter": "JPY",
          "rate": 326992.9402224206
        }
      }
    ]
  }]

Response parameters

uuid

string

Payment UUID

merchantId

string

Merchant ID

dateCreated

long

Payment creation date and time

expiryDate

long

Payment expiry date

quoteExpiryDate

long

Quote expiry date

reference

string

Payment external ID

type

string

IN for inbound payments. OUT for outbound payments

subType

string

Can be merchantPayIn, merchantPayOut or merchantRefund

status

string

Payment status. See the list of payment statuses in Payments How-Tos on the left

displayCurrency

object

Contains data about the payment price currency and amount

displayCurrency.currency

string

Payment price currency e.g. JPY

displayCurrency.amount

big decimal

Payment price amount

displayCurrency.actual

big decimal

The actual payment amount in price currency that the payment resulted in

walletCurrency

object

Contain data about both the payment's target wallet currency and the amount

walletCurrency.currency

string

The merchant's target wallet currency that the cryptocurrency payment will be converted and credited to

walletCurrency.amount

big decimal

The amount that will be received into the merchant's wallet if the customer sends the exact amount of cryptocurrency that they are supposed to send (see paidCurrency.amount)

walletCurrency.actual

big decimal

The actual amount that the merchant receives into their wallet after Coindirect converts cryptocurrency

paidCurrency

object

Contains data about the amount of cryptocurrency that the customer is supposed to send to the payment address. It also contains both the currency code and the actual amount of received cryptocurrency

paidCurrency.currency

string

Cryptocurrency code e.g. ETH

paidCurrency.amount

big decimal

The amount of cryptocurrency that is supposed to be sent to the payment address

paidCurrency.actual

big decimal

The actual amount of received cryptocurrency

feeCurrency

object

Contains data about payment fees

feeCurrency.currency

string

Fee currency code

feeCurrency.amount

big decimal

Fee amount that will be debited from the merchant's wallet balance if the customer sends the exact amount of cryptocurrency that they are supposed to send

feeCurrency.actual

big decimal

The actual fee amount that Coindirect debited from the merchant's wallet balance after processing the payment

displayRate

object

An object that contain data about the display rate.

displayRate.base

string

Base currency type

displayRate.counter

string

Couter currency type

displayRate.rate

big decmal

Rate

exchangeRate

object

An object that contains data about the paymen exchange rate

exchangeRate.base

string

Base currency code

exchangeRate.counter

string

Counter currency code

exchangeRate.rate

big decimal

Rate

address

object

Contains data about the cryptocurrency address and destination tag (in case of XRP)

address.protocol

string

The protocol type supported by the payment. If there are multiple protocols supported, see the data.address.alternatives array below

address.address

string

The payment address. This is the address that a customer needs to send their cryptocurrency to

address.tag

string

This is a payment destination tag. This fields isn't null when the paidCurrency.currency vlau is XRP. A destination tag should be viewable to the customer as destination tags indicate the beneficiary or destination for a payment. For example, a payment to an exchange or gateway address can use a destination tag to indicate which customer to credit for the amount of the payment in that business's own systems. A payment to a merchant could indicate what item or cart the payment is buying

address.uri

string

The destination address URI

address.alternatives[]

array

Fields are the same as in the case of the data.address array

redirectUrl

string

URL to the payment page that you can redirect your customers to

returnUrl

string

URL that the customer will be redirected to if they click a "Back to Merchant" button on the payment page

transactions[]

array

Contains data about received cryptocurrency transactions and exchange rates. If no transaction is received, it is empty

transactions[].dateCreated

long

Cryptocurrency transaction detection timestamp

transactions[].dateConfirmed

long

Cryptocurrency transaction confirmation timestamp

transactions[].hash

string

Cryptocurrency transaction hash

transactions[].amount

big decimal

Cryptocurrency transaction amount

transactions[].risk

object

Cryptocurrency transaction risk details

transactions[].risk.level

string

Cryptocurrency transaction risk levl. Can unknonw, low, medium or high

transactions[].resourceName

string

Cryptocurrency transaction resource name

transactions[].risk.resourceCategory

string

Cryptocurrency transaction resource category

transactions[].netwokFeeCurrency

string

Cryptocurrency transaction network fee details

transactions[].networkFeeAmount

big decimal

Cryptocurrency transaction

transactions[].sources

array, string

The wallet addresses that the cryptocurrency transaction was sent from

transactions[].exchangeRate

object

The exchange rate that was used to convert cryptocurrency to the wallet currency

transactions[].exchangeRate.base

string

Base currency

transactions[].exchangeRate.counter

string

Counter currency

transactions[].exchangeRate.rate

big decimal

Exhange rate

transactions[].displayRate

object

The display rate

transactions[].displayRate.base

string

Base currency

transactions[].displayRate.counter

string

Counter currency

transactions[].displayRate.rate

big decimal

Rate

Last updated