Payouts

Confirm payout

patch

Required scopes

This endpoint requires the following scopes:

• : Allows initiating a new settlement.
• : Allows creating a new payout.

Authorizations

some

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

payoutIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

successbooleanRequired

400

Default Response

application/json

404

Default Response

application/json

patch

/api/v1/payouts/{payoutId}/confirm

HTTPcURLJavaScriptPython

PATCH /api/v1/payouts/{payoutId}/confirm HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "success": true
}

Create payout

post

Required scopes

This endpoint requires the following scopes:

• : Allows initiating a new settlement.
• : Allows creating a new payout.

Authorizations

some

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Header parameters

idempotency-keystring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

referencestring · max: 255Required

descriptionany ofRequired

string · max: 1000Optional

or

undefined · enum · nullableOptionalPossible values:

Responses

200

Default Response

application/json

payoutIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

400

Default Response

application/json

404

Default Response

application/json

post

/api/v1/payouts

HTTPcURLJavaScriptPython

POST /api/v1/payouts HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
idempotency-key: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "reference": "text",
  "description": "text",
  "destination": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "paymentInstructionId": "text"
  },
  "source": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "paymentInstructionId": "text"
  }
}

{
  "payoutId": "123e4567-e89b-12d3-a456-426614174000",
  "errors": [
    {
      "errorCode": "text"
    }
  ],
  "quote": {
    "fee": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "fxQuote": {
      "isFirm": false,
      "rate": 1,
      "displayRate": 1,
      "quotedAt": "2026-04-03T09:54:43.057Z"
    },
    "source": {
      "amount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "minimumAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      }
    },
    "destination": {
      "amount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      }
    }
  }
}

Calculate quotes

post

Body

application/json

Responses

200

Default Response

application/json

fxQuoteany ofRequired

or

400

Default Response

application/json

404

Default Response

application/json

post

/api/v1/payouts/quotes

HTTPcURLJavaScriptPython

POST /api/v1/payouts/quotes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "destination": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "paymentInstructionId": "text"
  },
  "source": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "paymentInstructionId": "text"
  }
}

{
  "fee": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  },
  "fxQuote": {
    "isFirm": false,
    "rate": 1,
    "displayRate": 1,
    "quotedAt": "2026-04-03T09:54:43.057Z"
  },
  "source": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    },
    "minimumAmount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    }
  },
  "destination": {
    "amount": {
      "amount": "text",
      "asset": "text",
      "scale": 1
    }
  }
}

Get transaction ID by payout ID

get

Path parameters

payoutIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

400

Default Response

application/json

404

Default Response

application/json

get

/api/v1/payouts/{payoutId}/transaction-id

HTTPcURLJavaScriptPython

GET /api/v1/payouts/{payoutId}/transaction-id HTTP/1.1
Accept: */*

{
  "transaction": {
    "id": "text"
  }
}