Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Transfers

Get 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 Get Transfer endpoint to retrieve information about an existing incoming or outgoing transferthat was initiated by the <a href="ref:payhub_post_createTransfer" target="_blank">Create Transfer</a>.

post/getTransfer

Headers

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. The direction field in the response identifies whether this account is the source or destination of the funds. Pattern: PRN Example: "074103447228"

transferIdstring required

Unique identifier for the specific transfer to retrieve. Pattern: Alphanumeric string Example: "890e4567-e89b-12d3-a456-426614174222"

Response

Successful Response

transferIdstring required

The unique identifier for the transfer.

purposestring

The purpose provided for the transfer.

remittanceInfostring

Additional details about the transfer, such as an invoice number.

createdDatestring required

Timestamp when the transfer was created or received.

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

Payment network used for the transfer. Possible values:

accountNostring required

The <glossary:PRN> associated with this view of the transfer.

direction'IN' | 'OUT' required

Direction of the transfer relative to the specified account.

  • IN: The specified account is the destination account of the transfer
  • OUT: The specified account is the source account of the transfer

Note: Direction indicates transfer flow, but actual fund movement depends on the debit/credit indicator. For example, an incoming debit or outgoing credit may both result in funds leaving the specified account.

status'CREATED' | 'IN PROGRESS' | 'COMPLETED' | 'FAILED' | 'PENDING REVIEW' | 'SENT' | 'ACCEPTED WITHOUT POST' | 'BLOCKED' | 'REJECTED' | 'REQUESTED' | 'REQUEST APPROVED' | 'REQUEST REJECTED' required

Status of the transaction.

For FedNow and FedWire transactions:

  • CREATED: Initial state for transactions after creation via API call.
  • SENT: Outbound-only state indicating payment message (pacs.008 or pacs.004) successfully published to the payment network, awaiting pacs.002 status report.
  • IN PROGRESS: Transaction is being processed.
  • COMPLETED: Terminal success state. Payment network confirmed successful settlement via pacs.002 with ACSC or ACCC status.
  • FAILED: Terminal failure state. Transaction rejected by payment network or receiving FI initially.

For FedNow transactions only:

  • ACCEPTED WITHOUT POST: Special intermediate state for outbound payments. Received pacs.002 with ACWP status - funds have settled but receiving Financial Institution requires additional investigation time before posting.
  • BLOCKED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Receiving FI sent pacs.002 with BLCK status - funds are blocked and will not be posted.
  • REJECTED: Terminal state for outbound payments previously in ACCEPTED WITHOUT POST. Received pacs.002 with RJCT status after investigation - funds must be returned via new pacs.004.
  • REQUESTED: Return has been requested (FedNow returns only).
  • REQUEST APPROVED: Return request has been approved (FedNow returns only).
  • REQUEST REJECTED: Return request has been rejected (FedNow returns only).
statusDetailsstring required

Additional details or reasons for the current transfer status.

externalIdstring

Client-defined identifier provided when the transfer was created.

networkReferenceIdstring

Primary network reference for the transaction. For FedWire, this field contains the UETR. For FedNow, it contains either the UETR or the Transaction Identification, as indicated by the networkReferenceIdType in the railInformation field.

paymentType'RETURN' | 'CUSTOMER CREDIT TRANSFER'
  • RETURN: Funds sent back to the originator to reverse a specific transaction
  • CUSTOMER CREDIT TRANSFER: A standard payment initiated by the customer to a third party