Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Transfers

Create Transfer

👍 Availability

Some of the field descriptions for this endpoint reference FedNow or Fedwire, which are future capabilities not yet available for clients.

Use the Create Transfer endpoint to move funds between a source account and a destination account. You can use an active account link that was created by <a href="ref:paymenthub_post_createexternalaccountlink" target="_blank">Create External Account Link</a> or create a new one via the request.

For card transfers, the referenced external debit card link must have a validation status of "PASSED" before it can be used for transfers.

For new transfers: Omit the returnDetails field. For payment returns: Include the returnDetails field with the original transaction reference. When returnDetails is present, the request initiates a return of the original transfer.

post/createTransfer

Headers

x-gft-idempotency-keystring uuid4 required
Authorizationstring required
Example:Basic eW91cl9hcGlsb2dpbjp5b3VyX2FwaXRyYW5za2V5

Basic authentication token (base64-encoded {apilogin}:{apitranskey} credentials provided by SoFi Tech Solutions)

Request body

accountNostring required

The <glossary:PRN> associated with this transfer. Pattern: PRN Example: "074103447228"

paymentMethod'ACH' | 'FEDNOW' | 'FEDWIRE' | 'CARD' required

Payment network to use for the transfer. Rail-specific validation: CARD requires the sourceAccount to be GALILEO and creditOrDebit to be DEBIT or CREDIT. Example: "CARD"

creditOrDebit'DEBIT' | 'CREDIT' required

Posting type indicating debit or credit.

  • DEBIT: Debit transaction (funds withdrawn)
  • CREDIT: Credit transaction (funds deposited)
externalIdstring

Client-defined identifier for tracking and reconciliation. Pattern: Alphanumeric string Example: My-Internal-ID-123

purposestring

Reason for the transfer. Pattern: Alphanumeric string Validation:

  • Default: Alphanumeric string
  • FEDWIRE: Limited to alphanumeric and special characters: @&/'"`~()<>$#%+-={}*|[]^.,?!;:_ Example: "Bill Payment"
remittanceInfostring

Additional details about the transfer, such as an invoice number. Pattern: Alphanumeric string Validation:

  • Default: Alphanumeric string
  • FEDWIRE: 1-140 characters, limited to alphanumeric and special characters: @&/'"~()<>$#%+-={}*|[]^.,?!;:_ Example: "Invoice #456-ABC`"
isCrossBorderboolean

Indicates whether this is a cross-border (international) transfer. Currently supported for FEDWIRE only.

Response

Successful Response

transferIdstring required

Unique identifier assigned to the newly created transfer.