Skip to main content
GET
/
payouts
/
{payoutId}
Get Payout Status
curl --request GET \
  --url https://api.dfns.io/payouts/{payoutId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "pyt-4ihii-9lonb-tmhjo9bor4odmb5h",
  "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
  "fiatCurrency": "<string>",
  "asset": {
    "amount": "<string>",
    "contract": "<string>",
    "metadata": {
      "decimals": 123,
      "name": "<string>",
      "symbol": "<string>",
      "verified": true
    }
  },
  "requester": {
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
  },
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "data": {
    "borderlessAccountId": "<string>",
    "paymentInstructionsId": "<string>",
    "country": "<string>",
    "dateConfirmed": "2023-04-14T20:41:28.715Z",
    "dateCanceled": "2023-04-14T20:41:28.715Z",
    "statusReason": "<string>",
    "borderlessPayoutId": "<string>",
    "depositAddress": "<string>",
    "transferId": "<string>",
    "transactionHash": "<string>",
    "dateDepositConfirmed": "2023-04-14T20:41:28.715Z",
    "datePayoutConfirmed": "2023-04-14T20:41:28.715Z"
  },
  "externalId": "<string>",
  "dateFinalized": "2023-04-14T20:41:28.715Z"
}

​
Authentication

✅ Organization User (CustomerEmployee)
✅ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Payouts:Read: Always required.

Authorizations

​
Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

​
payoutId
string
required

Payout id.

Required string length: 1 - 64

Response

200 - application/json

Success

​
id
string
required

Payout id.

Required string length: 1 - 64
Pattern: ^pyt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"pyt-4ihii-9lonb-tmhjo9bor4odmb5h"

​
walletId
string
required

The wallet ID used for the payout.

Required string length: 1 - 64
Pattern: ^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"wa-5pfuu-9euek-h0odgb6snva8ph3k"

​
fiatCurrency
string
required

ISO-4217 fiat currency code for the payout.

​
asset
ERC-20 Asset · object
required

The asset being paid out, including token descriptor and metadata.

​
status
enum<string>
required

The current status of the payout.

Available options:
Processing,
Completed,
Failed,
Rejected,
Expired,
Canceled
​
requester
object
required

The user/token that initiated the payout.

​
dateCreated
string<date-time>
required

ISO 8601 date (must be UTC). ISO 8601 timestamp when the payout was created.

Example:

"2023-04-14T20:41:28.715Z"

​
provider
enum<string>
required
Available options:
Borderless
​
data
object
required

Borderless provider-specific payout data.

​
externalId
string

Optional external identifier for idempotency.

​
dateFinalized
string<date-time>

ISO 8601 date (must be UTC). ISO 8601 timestamp when the payout was finalized.

Example:

"2023-04-14T20:41:28.715Z"

Last modified on May 29, 2026