Skip to main content
GET
Node.js
Required scope: transfers:read Poll this endpoint to follow progress. failureReason explains a failed transfer, and approval may show that a payout is waiting for review. Use transactions to view your payment history; there is no transfer list endpoint.

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

Transfer.

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

A transfer's progress and accepted fees. Use balanceImpact, when present, to check how funds were debited, reserved or refunded; processing status alone does not confirm those balance changes.

message
string