API Reference

Create Wire Out Transfer

post
https://example.com/programs//accounts//wires

This new endpoint allows Partners to wire out transactions and testing in PIE.

Note: This feature must be explicitly requested and configured on a per partner basis. Contact your Green Dot Account Liaison for assistance.

How it works: Call POST …/accounts/{accountIdentifier}/wires and include the following information:

Path Params
string
required

The program code for the partner implementation.

string
required

The unique identifier for the account from which the wire will be sent.

Body Params

The Gd.Bos.DataTransfer.Request.WireOutRequest containing wire transfer details, including beneficiary and bank information.

string | null

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

double

Required. The amount to be transferred via wire.

string | null

Required. The ISO 4217 currency code for the transfer (e.g., "USD").

string | null

Optional. Other Beneficiary Information (OBI) to be included with the wire transfer.

string | null

Optional. A memo or note to associate with the wire transfer.

encryptedBeneficiaryData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

IntermediaryBank
object

Represents bank information required for wire transfers or ACH transactions. Contains the routing number and the name of the financial institution involved in the transaction. Used to identify intermediary or beneficiary banks in payment operations.

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