GAgalileo-ft
Billpay Webhook

Billpay Webhook

Use the Billpay webhook to approve or deny billpay transactions. Use the response_code field in the response to communicate your decision to SoFi Tech Solutions.

post/billpay

Request

  • Base URL
    https://client.domain.com
  • URL
    https://client.domain.com/billpay
  • Auth
    none declared. Required headers: X-Request-ID

Headers

X-Request-IDstring uuid required

A unique identifier for the HTTP request.

Request body

timestampstring required

Timestamp when this webhook message was sent. Format is <timestamp><timezone> where timestamp is YYYYmmdd:HHMMSS and timezone is always MST. Example: "20200315:121504MST"

billpay_trans_idinteger required

Unique system-generated billpay transaction ID. Example: 559386.

version'1.0' required

The version of this API. Hard-coded to "1.0".

jwtstring

The JSON web token (JWT) that authenticates the HTTP request from SoFi Tech Solutions. See the <a href="ref:api-reference-external-trans-api-about-external-trans-api-security" target="_blank">security overview</a> for more information and an example.

Example request

{
  "account": {
    "xid": 5398373,
    "prn": "999200002022"
  },
  "amounts": {
    "trans_amount": 150,
    "available_funds": 500,
    "currency": "840",
    "fee_amount": 3
  },
  "timestamp": "20200315:121504MST",
  "billpay_trans_id": 559386,
  "biller": {
    "biller_id": 1024930,
    "nickname": "Questar",
    "name": "Questar Gas",
    "address_1": "123 Las Vegas Blvd.",
    "address_2": "Suite 300",
    "city": "Las Vegas",
    "state_province": "NV",
    "postal_code": "88901",
    "phone": "7021231234"
  },
  "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnYWxpbGVvIiwiaWF0IjoxNTM0Mjc0ODgxLCJleHAiOjE1MzQyNzQ4ODZ9.1xUk4iNFGWLo01MyJUHXRlyrNlzwPvDMSXpN38TrblU"
}

Response

Your decision and instructions for SoFi Tech Solutions.

response_codestring required

Response code indicating how to process the billpay transaction. Possible response codes:

  • 00 — Approve

  • 01 — Reject; Insufficient funds

  • 98 — System Error; Reject and do not retry

  • 99 — System Error; Retry later

You can use 99 to tell SoFi Tech Solutions to retry later if your product is configured for retries.

Changes

No recorded changes to this operation across all 1 revision of this API.