API Reference

Create Single-Commit Transfer

post
https://example.com/programs//transfers/singlecommit

Executes a single-commit funds transfer in one step, using encrypted transfer route details. Returns the created transfer details, including identifier, status, and related accounts.

Path Params
string
required

The program code for the partner implementation. Identifies the specific program for which the transfer is being created.

Body Params

The Gd.Bos.DataTransfer.Request.SingleCommitTransferRequestEncrypted containing all required information for executing a single-commit transfer, including encrypted transfer route details (source, target, and transaction amount).

transferRoute
object

Represents the routing and endpoint details for a single-commit funds transfer operation. Contains the transaction amount and the source and target endpoints for the transfer. Used within !:SingleCommitTransferRequest to specify how and where funds should be moved in a single-step transfer.

string | null

Required. The unique identifier for the transfer. Used for tracking, idempotency, and reference.

string | null

Required. The type of transfer (e.g., "ACH", "A2A", "Wire").

string | null

Required. The type of authorization for the transfer (e.g., "execute", "hold").

string | null

Required. The identifier of the entity or user initiating the transfer.

string | null

An optional description for the transfer, such as the purpose or reference for the transaction.

string | null

Optional. Partner-specific reference data for the transfer.

Headers
string
required

A unique identifier (GUID) for tracking the request.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago