Skip to content

Latest commit

 

History

History
204 lines (133 loc) · 10.4 KB

PaymentsPayoutApi.md

File metadata and controls

204 lines (133 loc) · 10.4 KB

PaymentsPayoutApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method HTTP request Description
createPayout POST /payments/payout Create a payout instruction set
executePayoutAction POST /payments/payout/{payoutId}/actions/execute Execute a payout instruction set
getPayout GET /payments/payout/{payoutId} Get the status of a payout instruction set

createPayout

PayoutResponse createPayout()

Note: The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.

These endpoints are currently in beta and might be subject to changes.

If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email [email protected].

Create a payout instruction set.
A payout instruction set is a set of instructions for distributing payments from a single payment account to a list of payee accounts.
The instruction set defines:

  • the payment account and its account type (vault, exchange, or fiat).
  • the account type (vault account, exchange account, whitelisted address, network connection, fiat account, or merchant account), the amount, and the asset of payment for each payee account.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, PaymentsPayoutApiCreatePayoutRequest, PayoutResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: PaymentsPayoutApiCreatePayoutRequest = {
  // CreatePayoutRequest (optional)
  createPayoutRequest: {"paymentAccount":{"id":"EX_SUB1","type":"EXCHANGE_ACCOUNT"},"instructionSet":[{"payeeAccount":{"id":"bef85a1c-b605-4b2e-bdb5-2d400f4d0bf3","type":"EXTERNAL_WALLET"},"amount":{"amount":"43","assetId":"USDC"}},{"payeeAccount":{"id":"3adc1f92-e791-44a8-9aee-7f31c2108b78","type":"NETWORK_CONNECTION"},"amount":{"amount":"4423","assetId":"USDC"}}]},
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.paymentsPayout.createPayout(body).then((res: FireblocksResponse<PayoutResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
createPayoutRequest CreatePayoutRequest
idempotencyKey [string] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) defaults to undefined

Return type

PayoutResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The payout instruction set creation succeeded and returns the generated instruction set with a unique payout IDThe payout ID will be used for executing the payout and checking the payout status. -
400 Bad request -
401 Unauthorized. Missing / invalid JWT token in Authorization header. -
5XX Internal error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

executePayoutAction

DispatchPayoutResponse executePayoutAction()

Note: The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.

These endpoints are currently in beta and might be subject to changes.

If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email [email protected].

Execute a payout instruction set.

The instruction set will be verified and executed.
Source locking
 If you are executing a payout instruction set from a payment account with an already active payout the active payout will complete before the new payout instruction set can be executed.
You cannot execute the same payout instruction set more than once.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, PaymentsPayoutApiExecutePayoutActionRequest, DispatchPayoutResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: PaymentsPayoutApiExecutePayoutActionRequest = {
  // string | the payout id received from the creation of the payout instruction set
  payoutId: 1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.paymentsPayout.executePayoutAction(body).then((res: FireblocksResponse<DispatchPayoutResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
payoutId [string] the payout id received from the creation of the payout instruction set defaults to undefined
idempotencyKey [string] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional) defaults to undefined

Return type

DispatchPayoutResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Executed the payout instruction set -
400 Bad request -
401 Unauthorized. Missing / invalid JWT token in Authorization header. -
5XX Internal error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPayout

PayoutResponse getPayout()

Note: The reference content in this section documents the Payments Engine endpoint. The Payments Engine endpoints include APIs available only for customers with Payments Engine enabled on their accounts.

These endpoints are currently in beta and might be subject to changes.

If you want to learn more about Fireblocks Payments Engine, please contact your Fireblocks Customer Success Manager or email [email protected].

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, PaymentsPayoutApiGetPayoutRequest, PayoutResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: PaymentsPayoutApiGetPayoutRequest = {
  // string | the payout id received from the creation of the payout instruction set
  payoutId: 1fe3b61f-7e1f-4a19-aff0-4f0a524d44d7,
};

fireblocks.paymentsPayout.getPayout(body).then((res: FireblocksResponse<PayoutResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
payoutId [string] the payout id received from the creation of the payout instruction set defaults to undefined

Return type

PayoutResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Returns the current status of the payout instruction set, including the status of each payout instruction and the transactions created in the process. -
401 Unauthorized. Missing / invalid JWT token in Authorization header. -
404 No payout with the given payout ID exists. -
5XX Internal error. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]