The billpay process must retry a transaction that was sent to the External Trans API. Either a timeout occurred, or you indicated that we should try again later.
- Code —
BPAR - Event trigger — The billpay webhook process failed and a retry will occur, or you responded with code
99(error, retry). - Process — This process contains the event trigger:
- Billpay webhook sent
Fields
All fields are strings. Your field names may vary. Default fields are included in the default webhook template. See Default and optional fields for more information.
| Field | Default | Description |
|---|---|---|
| act_type | For all bill payments and refund checks the activity type is |
|
| amount | X | Amount of the payment. Example: |
| balance_id | X | The balance ID, also called the |
| billername | X | Name of the biller. |
| billpay_id | X | Unique identifier for this billpay or refund-check transaction. Example: |
| ch_group_id | Corporate Hierarchy group identifier. Example: |
|
| credit_balance | For credit accounts, the total amount of unpaid purchases and advances. Example: |
|
| msg_event_id | Unique system-generated identifier for this message. Example: |
|
| msg_id | The four-letter code to identify this event. Example: |
|
| open_to_buy | X | The available balance to spend. Example: |
| pmt_ref_no | X | SoFi Tech Solutions 12-digit payment reference number (PRN) for the account. Example: |
| prod_id | X | The product ID of the account. Example: |
| prog_id | X | The program ID of the account. Example: |
| timestamp | X | Timestamp for when this event was created, in system time. Format: |
| type | X | The name of this event: |
Example
# billpay_retry example:
{
"act_type": "AD",
"amount": "376.50",
"balance_id": "20211",
"billpay_id": "2436543",
"credit_balance": "325.00",
"msg_event_id": "243693",
"msg_id": "BPAR",
"open_to_buy": "500.00",
"pmt_ref_no": "999101003022",
"prod_id": "1701",
"prog_id": "305",
"timestamp": "2025-01-31 17:20:33 MST",
"type": "billpay_retry"
}