Skip to main content
POST
/
gateway
/
process--billpay
Push funds to a bill payment account
curl --request POST \
  --url https://payapi-sandbox.ingo.money/gateway/process--billpay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participant_id": 12345,
  "timestamp": 1587052232,
  "version": 11,
  "amount": 1010.5,
  "participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
  "customer_account_token": "a74eacf4-32e8-4081-b69c-565a89dd6cf1",
  "account_type": "BP",
  "source_of_funds": 4,
  "participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5",
  "store_id": "STORE-001",
  "clerk_id": "CLK-007",
  "terminal_id": "TERM-042"
}
'
import requests

url = "https://payapi-sandbox.ingo.money/gateway/process--billpay"

payload = {
    "participant_id": 12345,
    "timestamp": 1587052232,
    "version": 11,
    "amount": 1010.5,
    "participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
    "customer_account_token": "a74eacf4-32e8-4081-b69c-565a89dd6cf1",
    "account_type": "BP",
    "source_of_funds": 4,
    "participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5",
    "store_id": "STORE-001",
    "clerk_id": "CLK-007",
    "terminal_id": "TERM-042"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    participant_id: 12345,
    timestamp: 1587052232,
    version: 11,
    amount: 1010.5,
    participant_unique_id1: 'f8f68709-8e5d-4c19-8ca0-2eaffef4ec57',
    customer_account_token: 'a74eacf4-32e8-4081-b69c-565a89dd6cf1',
    account_type: 'BP',
    source_of_funds: 4,
    participant_unique_id2: '257b5bae-d52f-42e2-8f2c-0700d8d7a7a5',
    store_id: 'STORE-001',
    clerk_id: 'CLK-007',
    terminal_id: 'TERM-042'
  })
};

fetch('https://payapi-sandbox.ingo.money/gateway/process--billpay', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://payapi-sandbox.ingo.money/gateway/process--billpay",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'participant_id' => 12345,
    'timestamp' => 1587052232,
    'version' => 11,
    'amount' => 1010.5,
    'participant_unique_id1' => 'f8f68709-8e5d-4c19-8ca0-2eaffef4ec57',
    'customer_account_token' => 'a74eacf4-32e8-4081-b69c-565a89dd6cf1',
    'account_type' => 'BP',
    'source_of_funds' => 4,
    'participant_unique_id2' => '257b5bae-d52f-42e2-8f2c-0700d8d7a7a5',
    'store_id' => 'STORE-001',
    'clerk_id' => 'CLK-007',
    'terminal_id' => 'TERM-042'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://payapi-sandbox.ingo.money/gateway/process--billpay"

	payload := strings.NewReader("{\n  \"participant_id\": 12345,\n  \"timestamp\": 1587052232,\n  \"version\": 11,\n  \"amount\": 1010.5,\n  \"participant_unique_id1\": \"f8f68709-8e5d-4c19-8ca0-2eaffef4ec57\",\n  \"customer_account_token\": \"a74eacf4-32e8-4081-b69c-565a89dd6cf1\",\n  \"account_type\": \"BP\",\n  \"source_of_funds\": 4,\n  \"participant_unique_id2\": \"257b5bae-d52f-42e2-8f2c-0700d8d7a7a5\",\n  \"store_id\": \"STORE-001\",\n  \"clerk_id\": \"CLK-007\",\n  \"terminal_id\": \"TERM-042\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://payapi-sandbox.ingo.money/gateway/process--billpay")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"participant_id\": 12345,\n  \"timestamp\": 1587052232,\n  \"version\": 11,\n  \"amount\": 1010.5,\n  \"participant_unique_id1\": \"f8f68709-8e5d-4c19-8ca0-2eaffef4ec57\",\n  \"customer_account_token\": \"a74eacf4-32e8-4081-b69c-565a89dd6cf1\",\n  \"account_type\": \"BP\",\n  \"source_of_funds\": 4,\n  \"participant_unique_id2\": \"257b5bae-d52f-42e2-8f2c-0700d8d7a7a5\",\n  \"store_id\": \"STORE-001\",\n  \"clerk_id\": \"CLK-007\",\n  \"terminal_id\": \"TERM-042\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://payapi-sandbox.ingo.money/gateway/process--billpay")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"participant_id\": 12345,\n  \"timestamp\": 1587052232,\n  \"version\": 11,\n  \"amount\": 1010.5,\n  \"participant_unique_id1\": \"f8f68709-8e5d-4c19-8ca0-2eaffef4ec57\",\n  \"customer_account_token\": \"a74eacf4-32e8-4081-b69c-565a89dd6cf1\",\n  \"account_type\": \"BP\",\n  \"source_of_funds\": 4,\n  \"participant_unique_id2\": \"257b5bae-d52f-42e2-8f2c-0700d8d7a7a5\",\n  \"store_id\": \"STORE-001\",\n  \"clerk_id\": \"CLK-007\",\n  \"terminal_id\": \"TERM-042\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": 100,
  "client_message": "Success",
  "data": {
    "estimated_posting_time": "Payment will post 04/22/2026",
    "estimated_posting_date": "04/22/2026",
    "transaction_id": 2361538,
    "request_timestamp": 1587052280,
    "customer_account_token": "a74eacf4-32e8-4081-b69c-565a89dd6cf1",
    "participant_unique_id1": "f8f68709-8e5d-4c19-8ca0-2eaffef4ec57",
    "participant_unique_id2": "257b5bae-d52f-42e2-8f2c-0700d8d7a7a5"
  }
}
{
  "status": 700,
  "client_message": "Account not currently available for payment",
  "data": {
    "request_timestamp": 1587052280
  }
}

Body

application/json
​
participant_id
integer
required

Unique participant identifier assigned by Ingo.

Example:

12345

​
timestamp
integer<int64>
required

Unix timestamp of the request.

Example:

1587052232

​
version
integer
required

API version of the request. Current version is 11.

Example:

11

​
amount
number<float>
required

Amount of the transaction.

Required range: x >= 0.01
Example:

1010.5

​
participant_unique_id1
string
required

Participant assigned transaction ID for the process request. Value must be unique and may not contain NPI data. Used for idempotency — a duplicate value returns an idempotent response without initiating a new push request. Appears on daily reconciliation reports.

Required string length: 1 - 255
Example:

"f8f68709-8e5d-4c19-8ca0-2eaffef4ec57"

​
customer_account_token
string
required

Token representing the account number and customer data as provided in the response from a previous Verify API call.

Required string length: 1 - 255
Example:

"a74eacf4-32e8-4081-b69c-565a89dd6cf1"

​
account_type
enum<string>
required

Always BP for bill payment disbursements.

Available options:
BP
Minimum string length: 1
Example:

"BP"

​
source_of_funds
enum<integer>
required

Funding source indicator: 1 = Cash, 2 = Check, 3 = Combo of Cash & Check, 4 = Corp Disbursement.

Available options:
1,
2,
3,
4
Example:

4

​
participant_unique_id2
string | null

Optional second participant assigned transaction ID. Does not appear on daily reconciliation reports.

Maximum string length: 255
Example:

"257b5bae-d52f-42e2-8f2c-0700d8d7a7a5"

​
store_id
string | null

Client assigned store ID. Required for Retail client participants.

Maximum string length: 255
Example:

"STORE-001"

​
clerk_id
string | null

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 255
Example:

"CLK-007"

​
terminal_id
string | null

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 255
Example:

"TERM-042"

​
recipient_phone
integer

10-digit recipient phone number. Digits only.

Example:

5555550100

​
ledger
object

Ledger information. Required for clients with ledger program configuration.

Response

Payment accepted successfully

​
status
integer

Numeric code describing the status of the API request. 100 = Success.

Example:

100

​
client_message
string

Text description associated with the status code.

Example:

"Success"

​
data
object