Skip to main content
POST
/
bankaccounts
/
{id}
/
requisitions
Create a requisition
curl --request POST \
  --url https://api.smokeball.com/bankaccounts/{id}/requisitions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "matterId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
  "payeeId": "18c05819-c321-4907-800c-d5a608729c5a",
  "transactionType": "ElectronicPayment",
  "amount": 100.5,
  "approverUserId": "18c05819-c321-4907-800c-d5a608729c5a",
  "payorId": "18c05819-c321-4907-800c-d5a608729c5a",
  "reference": "REF123456",
  "effectiveDate": "2023-11-07T05:31:56Z",
  "accountName": "John Doe",
  "bsb": "123456",
  "accountNumber": "12345678",
  "organizationOrCompanyName": "ACME Corporation",
  "billerCode": "12345",
  "billerReference": "REF123456",
  "reason": "Payment for services rendered",
  "internalNote": "Internal note about this payment"
}
'
{
  "id": "18c05819-c321-4907-800c-d5a608729c5a",
  "status": "Approved",
  "protectedBalance": 1000,
  "availableBalance": 5000,
  "totalBalance": 6000,
  "pdfPaymentDetail": "<string>"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Body

​
matterId
string
required

Unique identifier of the associated matter. Required.

Minimum string length: 1
Example:

"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"

​
payeeId
string
required

Unique identifier of the person or organisation being paid. Required.

Minimum string length: 1
Example:

"18c05819-c321-4907-800c-d5a608729c5a"

​
transactionType
string
required

Transaction type. Required.

Example:

"ElectronicPayment"

​
amount
number<double>
required

The payment amount in dollars. Limited to 2 decimal places (cents).

Required range: x >= 0.01
Example:

100.5

​
approverUserId
string | null

Approver user ID. Optional. If not provided, default approver will be used.

Example:

"18c05819-c321-4907-800c-d5a608729c5a"

​
payorId
string | null

Unique identifier of the Payor/Contact ID. Required in US region only.

Example:

"18c05819-c321-4907-800c-d5a608729c5a"

​
reference
string | null

Payment reference.

Example:

"REF123456"

​
effectiveDate
string<date-time>

Date of requisition.

​
accountName
string | null

Account name. Required when TransactionType is ElectronicPayment and using DirectDeposit (provide AccountName, BSB, and AccountNumber).

Example:

"John Doe"

​
bsb
string | null

BSB (Bank State Branch). Required when TransactionType is ElectronicPayment and using DirectDeposit (provide AccountName, BSB, and AccountNumber).

Example:

"123456"

​
accountNumber
string | null

Account number. Required when TransactionType is ElectronicPayment and using DirectDeposit (provide AccountName, BSB, and AccountNumber).

Example:

"12345678"

​
organizationOrCompanyName
string | null

Organization or company name. Required when TransactionType is ElectronicPayment and using BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

Example:

"ACME Corporation"

​
billerCode
string | null

Biller code. Required when TransactionType is ElectronicPayment and using BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

Example:

"12345"

​
billerReference
string | null

Biller reference. Required when TransactionType is ElectronicPayment and using BPAY (provide OrganizationOrCompanyName, BillerCode, and BillerReference).

Example:

"REF123456"

​
reason
string | null

Reason for the payment. Free format string.

Example:

"Payment for services rendered"

​
internalNote
string | null

Internal note. Free format string.

Example:

"Internal note about this payment"

Response

When request is accepted. Returns requisition status and balances.

​
id
string | null

Requisition ID if requisition requires approval.

Example:

"18c05819-c321-4907-800c-d5a608729c5a"

​
status
string

Status of the requisition (e.g., Pending, Approved).

Example:

"Approved"

​
protectedBalance
number<double>

Protected balance after the requisition.

Example:

1000

​
availableBalance
number<double>

Available balance after the requisition.

Example:

5000

​
totalBalance
number<double>

Total balance after the requisition.

Example:

6000

​
pdfPaymentDetail
string | null

Link to the PDF payment detail document.