Skip to main content
POST
/
payouts
Create Payout
curl --request POST \
  --url https://api.dfns.io/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-DFNS-USERACTION: <api-key>' \
  --data '
{
  "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
  "asset": {
    "kind": "Erc20",
    "amount": "<string>",
    "contract": "<string>"
  },
  "fiatCurrency": "<string>",
  "provider": "Borderless",
  "country": "<string>",
  "borderlessAccountId": "<string>",
  "paymentInstructionsId": "<string>",
  "paymentPurpose": "salary payment",
  "externalId": "<string>"
}
'
{
  "id": "pyt-4ihii-9lonb-tmhjo9bor4odmb5h",
  "walletId": "wa-5pfuu-9euek-h0odgb6snva8ph3k",
  "fiatCurrency": "<string>",
  "asset": {
    "kind": "Erc20",
    "amount": "<string>",
    "contract": "<string>",
    "network": "Algorand",
    "metadata": {
      "decimals": 123,
      "name": "<string>",
      "symbol": "<string>",
      "verified": true
    }
  },
  "status": "Processing",
  "requester": {
    "userId": "us-6b58p-r53sr-rlrd3l5cj3uc4ome",
    "tokenId": "to-202a0-cdo33-o65mbt6q758lvvnt"
  },
  "dateCreated": "2023-04-14T20:41:28.715Z",
  "provider": "Borderless",
  "data": {
    "borderlessAccountId": "<string>",
    "paymentInstructionsId": "<string>",
    "paymentPurpose": "salary payment",
    "executionStatus": "Initializing",
    "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:Create: Always required.

Authorizations

​
Authorization
string
header
required

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

​
X-DFNS-USERACTION
string
header
required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Body

application/json
​
walletId
string
required

The wallet ID to remit funds from.

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"

​
asset
ERC-20 Asset · object
required

The asset to be paid out.

​
fiatCurrency
string
required

ISO-4217 fiat currency code for the payout.

Pattern: ^[A-Z]{3}$
​
provider
enum<string>
required
Available options:
Borderless
​
country
string
required

ISO-3166 Alpha-2 country code for the payout destination.

Pattern: ^[A-Z]{2}$
​
borderlessAccountId
string
required

Borderless account ID specifying who is paying out funds.

​
paymentInstructionsId
string
required

Borderless payment instructions ID specifying fiat settlement instructions.

​
paymentPurpose
enum<string>
required

Borderless reason/purpose for the payment.

Available options:
salary payment,
personal remittance,
rent payment,
property purchase,
owned account abroad,
advertising expenses,
advisory fees,
business insurance,
construction,
delivery fees,
education,
exports,
donation,
hotel,
loan payment,
maintenance expenses,
medical expense,
office expenses,
royalty fees,
service charge,
shares investment,
tax payment,
transportation fees,
travel,
utility bills,
other
​
externalId
string

Optional idempotency key to ensure only one payout is created.

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 March 5, 2026