BPMT: pmt

webhook

pmt

A payment (deposit) was posted. The funds are available for spending. Available balance has increased by the specified amount. If the deposit is delayed, the BDPM: pmt_delayed message is sent instead.

Trigger — The specified amount is credited to the account.
Processes — These processes contain the event trigger:
- Program API endpoints:
- ACH transactions
- Wire transactions
- Customer Service Tool
- Internal administrative processes that move funds into customer accounts

Payload

account_status

string

See Account Statuses for possible values.

ach_acct_id

string

The ACH account to which the payment was posted.

ach_source_trace

string

Trace ID for an ACH transaction, generated by the originator. 15 digits.

ach_trans_id

string

Unique system-generated identifier for an ACH transaction. For BADJ and BPMT, this field may contain the auth_id of a card-load transaction.

act_type

string

See Activity Type for possible values.

amount

string

Amount of the transaction. Unsigned.

available_balance

string

Amount available to spend at the time of the event. Legacy field: balance.

bai

string

Visa Business Application Identifier (BAI) for the transaction, first two characters. Example: "AA"

balance_id

string

The balance ID, also called the galileo_account_number. Legacy field: account_id.

batch_header

string

The batch-file header for the Nacha file. ACH transactions only.

cad

string

System-generated card ID, which has a 1:1 relationship with the PAN. Legacy field: card_id.

card_status

string

Card status code. See Card Statuses for possible values. Because freezing a card does not change its status, this status is the same as before the freeze.

ch_group_id

string

Corporate Hierarchy group identifier.

client_id

string

ID for the customer record.

company_entry_desc

string

Company descriptor found in the batch header of the Nacha file.

currency_code

string

ISO 4217 numeric currency code for amount (the cardholder account currency). Legacy fields: cur_code, currency.

description

string

Human-readable description of the transaction or event type.

effective_ach_dt

string

For an ACH transaction, this is the effective date when the ACH payment should post. Usually set by the bank to the actual date when the payment is posted, in case we post the payment early. Format: MM/DD/YYYY.`

event_ts

string

Timestamp when the message was ingested by SoFi Tech Solutions (Mountain Standard Time). Format: "YYYY-MM-DD hh:mm:ss MST". Legacy fields: timestamp, tran_timestamp.

ext_trans_id

string

External transaction ID.

external_account_id

string

User-supplied identifier to link to an external system.

hold_days

string

Number of days that a payment was held before posting.

incoming_ach_days_early

string

The number of days before settle_standard_date that the ACH transaction posted. This field is available only if ACH early access is enabled with the FBEEA parameter.

mcc

string

Merchant category code (DE018).

merchant_country_code

string

Mastercard credit only. The 3-letter code of the country where the merchant is officially located (ISO 3166-1).

method

string

Event category. Indicates the type of event.

msg_event_id

string

Unique system-generated identifier for this message.

msg_id

string

The four-letter code to identify this event.

odfi_routing_number

string

Routing number for the originating depository financial institution (ODFI) of an ACH or wire transaction. Nine digits.

orig_acct_number

string

ACH or wire originator account number.

orig_name

string

ACH, Real-Time Payment (RTP), or wire originator name. See Originator and source names for details.

otype

string

See Transaction Types for possible values.

pmt_id

string

System-generated identifier for this payment.

pmt_source_id

string

Identifier for the transaction that triggered this payment.

prn

string

SoFi Tech Solutions 12-digit payment reference number (PRN) for the account. Legacy field: pmt_ref_no.

prod_id

string

The product ID of the account.

prog_id

string

The program ID of the account.

receiver_name

string

Name on the ACH or Real-Time Payment (RTP) recipient account.

reference_id

string

For incoming Real-Time Payments (RTP) or wires, the input message accountability data (IMAD).

sec_code

string

Standard entry class code. See SEC Codes Requirements for ACH for valid values.

settle_standard_date

string

Settlement date from the ACH file. This is when funds from incoming ACH transactions would post if early access for direct deposits were disregarded. Format: MM/DD/YYYY.

source_inst_name

string

For ACH transactions, the name of the originator. See the Originator and source names in the ACH for Businesses guide for details.

transaction_id

string

External or network-assigned transaction identifier.

type

string

Name of this event: "pmt"

user_data

string

Populated according to your use case and needs by arrangement with SoFi Tech Solutions.

Loading…