Skip to main content
GET
Node.js
Required scope: recipient_read payoutReadiness describes the recipient’s saved state: unavailable means it cannot currently be used; review_pending means review is pending; review_refresh_required means a new review is needed; checks_required means quote and payment checks are still required. usableForPayout is a selection hint and does not mean approval to send. Reading this endpoint does not run new payment checks. Create a quote and check its result before sending.

Authorizations

x-ledig-key
string
header
required

Your business API key ID. Keep its secret on your server and use that secret to sign each request.

x-ledig-timestamp
string
header
required

The current Unix timestamp in seconds, used in the signed request.

x-ledig-signature
string
header
required

The request's HMAC-SHA256 signature. Use the v1= prefix for supported own-business requests, or v2= when acting for a managed business with signed business-selection headers. Follow the authentication guide to construct and sign the exact request.

Path Parameters

id
string
required

Response

Recipient.

status
string
required
Allowed value: "success"
data
object
required

A saved payment destination with its review status and payment eligibility.

message
string