Jump to Content
API Reference
Guides
API Reference
API Reference
API Reference
Guides
API Reference
List Items
Search
JUMP TO
Assembly API
Overview
Authentication
Token
post
Addresses
Show Address
get
Bank Accounts
Show Bank Account
get
Redact Bank Account
delete
Send Penny Amount
patch
Create Bank Account
post
Verify Penny Amount
patch
Show Bank Account User
get
Validate Routing Number
get
BPay Accounts
Show BPay Account
get
Redact BPay Account (Future Feature)
delete
Create BPay Account
post
Show BPay Account User
get
Wallet Accounts
Pay a Bill
post
Show Wallet Account User
get
Withdraw Funds
post
Show Wallet Account
get
Show Wallet Account NPP Details
get
Show Wallet Account BPAY Details
get
UK: Show Wallet Account Payin Details
get
Sub-wallets
List Sub-wallets
get
Create Sub-wallet
post
Show Sub-wallet
get
Redact Sub-wallet
delete
Update Sub-wallet
patch
Fund transfers
patch
List Sub-wallet transactions
get
Pay a Bill
post
Withdraw Funds
post
Show Sub-wallet User
get
Show the Wallet Account of a Sub-wallet
get
Users
List User's BPay Accounts
get
Show User Card Account
get
Show User
get
Update User
patch
Verify User (Prelive Only)
patch
Show User Bank Account
get
Set User Disbursement Account
patch
List Users
get
Create User
post
List User Items
get
Show User Wallet Account
get
Callbacks
Show Callback
get
Delete Callback
delete
Update Callback
patch
List Callback Responses
get
Show Callback Response
get
List Callbacks
get
Create Callback
post
Card Accounts
Create Card Account
post
Show Card Account User
get
Verify Card
patch
Show Card Account
get
Redact Card Account
delete
Companies
List Companies
get
Create Company
post
Show Company
get
Update Company
patch
Direct Debit Authorities
List Direct Debit Authorities
get
Create Direct Debit Authority
post
Show Direct Debit Authority
get
Fees
List Fees
get
Create fee
post
Show Fee
get
Charges
List Charges
get
Create Charge
post
Show Charge
get
Show Charge Status
get
Show Charge Buyer
get
Marketplaces
Show Marketplace
get
Token Auth
Generate Token
post
Tools
Health check
get
Transactions
List Transactions
get
Show Transaction Bank Account
get
Show Transaction
get
Show Transaction Card Account
get
Show Transaction Fees
get
Show Transaction Wallet Account
get
Show Transaction User
get
Batch Transactions
List Batch Transactions
get
Show Batch Transaction
get
Disbursements
List Disbursements
get
Show Disbursement
get
Show Disbursement Transactions
get
Show Disbursement Wallet Accounts
get
Show Disbursement Bank Accounts
get
Show Disbursement Users
get
Show Disbursement Items
get
Items
List Items
get
Create Item
post
Show Item
get
Delete Item
delete
Update Item
patch
Show Item Seller
get
Show Item Buyer
get
Show Item Fees
get
Show Item Wire Details
get
List Item Transactions
get
List Item Batch Transactions
get
Show Item Status
get
Item Actions
Make Payment
patch
Cancel
patch
Refund
patch
Authorize Payment
patch
Capture Payment
patch
Void Payment
patch
Release Payment (Deprecated - Do Not Use)
patch
Virtual Accounts and PayIDs
Overview
Virtual Accounts
Create Virtual Account
post
List Virtual Accounts
get
Show Virtual Account
get
Update AKA Names
patch
Update Account Name
patch
PayIDs
Register PayID
post
Update PayID Status
patch
Retrieve a PayID
get
PayTo
Overview
PayTo Payments
Initiate PayTo Payment
post
Get PayTo Payment Initiation Request Details
get
Get All PayTo Payment Initiation Requests for an Agreement
get
PayTo Agreements
Create PayTo Agreement
post
Validate PayTo Agreement
post
Amend PayTo Agreement Status
patch
Recall PayTo Agreement
patch
Amend PayTo Agreement Details
patch
Get PayTo Agreement Details
get
Get All PayTo Agreements for a User
get
Supplementary Data API
Overview
Transaction supplementary data
Show Transaction Supplementary Data
get
Failed NPP Payment Details
Failed NPP Payment Details
get
Webhooks API
Overview
Status
Check health of server
get
Webhooks
Create a Webhook
post
List Webhooks
get
Create a Secret Key
post
Show Webhook
get
Update an existing Webhook
patch
Delete Webhook by ID
delete
Jobs
Get jobs associated to Webhook
get
Show job associated to Webhook
get
Asynchronous API
Overview
Item Actions
Make Payment
patch
Requests
Get Request Status
get
Get Request Callback Details
get
List Items
get
https://test.api.promisepay.com/items
OK
Language
Shell
Ruby
PHP
JavaScript
C#
Credentials
Basic
:
URL
Base URL
https://test.api.promisepay.com
/items
