Solverr

Payouts

Get a payout

Returns one payout and its current status. Rate limit: 60 per minute per API key, shared with the other endpoints that have this limit.

GET
/api/v1/payouts/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

A live API key, sk_live_ followed by 32 base58 characters.

Path Parameters

id*string

Refund id (starting with ref_) or payout id (starting with pay_).

Response Body

The payout.

application/json
  1. response

A refund or a payout. Money leaves the business's payout wallet only after the business approves it at sign_url.

id*string

Starts with ref_ for refunds and pay_ for payouts.

object*string
Value in"refund""payout"
status*string
Value in"pending""processing""completed""failed""canceled"
invoice_id*string|null
batch_id*|

Set for payouts created together, from a CSV in the dashboard or with POST /api/v1/payouts/batch.

amount*string

Amount of the business's settlement coin to send.

source_asset*string

The business's settlement coin.

asset_id*string

The coin the recipient receives.

recipient*string
tx_hash*string|null
failure_reason*string|null
sign_url*string

Dashboard page where the business approves the transfer from its payout wallet.

Formaturi
created_at*string
Formatdate-time
Example Request
curl -X GET 'https://example.com/api/v1/payouts/string'
Example Response
{  "id": "string",  "object": "refund",  "status": "pending",  "invoice_id": "string",  "batch_id": "string",  "amount": "string",  "source_asset": "string",  "asset_id": "string",  "recipient": "string",  "tx_hash": "string",  "failure_reason": "string",  "sign_url": "http://example.com",  "created_at": "2019-08-24T14:15:22Z"}