API Reference
Supported Operations
- Create and cancel bill pay transactions
- Retrieve transaction details
- Browse the merchant directory
- Manage account-level merchants
- Generate an embedded bill pay iFrame URL
Endpoints
Create Bill Pay Transaction
POST /api/v2/bill-pay/create
Submits a bill payment to a registered merchant on behalf of a customer.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| Amount | decimal | Yes | Payment amount |
| MerchantID | string | Yes | ID of the target merchant (biller) |
| AccountNumber | string | Yes | Customer's account number with the merchant |
| ClientAccountID | string | Optional | Link transaction to a sub-account |
| ClientReferenceNumber | string | Optional | Your internal reference number |
| IdempotencyKey | string | Optional | Unique key to prevent duplicate payments |
| Notes | string | Optional | Internal notes |
Cancel Bill Pay Transaction
POST /api/v2/bill-pay/cancel
Cancels a pending bill pay transaction.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransactionID | string | Yes | The transaction ID to cancel |
Get Bill Pay Transaction
GET /api/v2/bill-pay/transaction
Returns details of a single bill pay transaction.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| TransactionID | string | Yes | The transaction ID returned from /bill-pay/create |
Get Merchants
GET /api/v2/bill-pay/merchants
Returns the full list of supported bill pay merchants (billers).
No additional parameters required.
Generate Embed URL
POST /api/v2/bill-pay/generate-embed-url
Generates a URL for the hosted bill pay iframe experience.
No additional parameters required beyond authentication.
Add Account Merchants
POST /api/v2/bill-pay/account/merchants/add
Adds one or more merchants to the account's custom merchant list.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| MerchantID | string | Yes | ID of the merchant to add |
Edit Account Merchants
POST /api/v2/bill-pay/account/merchants/edit
Updates a merchant in the account's custom merchant list.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| MerchantID | string | Yes | ID of the merchant to edit |
Delete Account Merchants
POST /api/v2/bill-pay/account/merchants/delete
Removes a merchant from the account's custom merchant list.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| MerchantID | string | Yes | ID of the merchant to remove |
Get Account Merchants
GET /api/v2/bill-pay/account/merchants
Returns the custom merchant list configured for the account.
No additional parameters required.
Updated 2 days ago