v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Transfers

Create Wire Out Transfer

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:

post/programs/{programCode}/accounts/{accountIdentifier}/wires

Path parameters

programCodestring required

The program code for the partner implementation.

accountIdentifierstring required

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

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Request body

wireIdentifierstring nullable

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

amountnumber double

Required. The amount to be transferred via wire.

currencystring nullable

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

obistring nullable

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

memostring nullable

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

Response

Created