Create Bank Draft

post https://example.com/retail/web/{Company}/Retail/Accounts/{AccountNumber}/BankDraft

Generate a bank draft from an account.

Path Params

Company

string

required

The GET /System/Companies endpoint from the System Admin specification can be used to find an available value for this path parameter.

AccountNumber

number

required

The GET /{Company}/Retail/Accounts endpoint from the Retail specifications can be used in order to find values that satisfy this parameter.

Body Params

TellerBranch

string

required

Branch code of the teller performing the transfer

TransactionDate

date

required

The date on which this transaction should be posted

TransactionCode

string

required

Transaction code.

BankCode

string

required

Bank code.

ChequeNumber

number

required

Cheque number to assign.

Amount

number

required

The amount of the bank draft.

Payee

integer

Existing Portfolio+ client number. If Payee is not populated, then ExternalPayee details must be provided.

ExternalPayee

object

Comment1

string

First line of the comment.

Comment2

string

Second line of the comment.

Comment3

string

Third line of the comment.

Note

string

A not to attach to the transaction.

ReceiptNumber

integer

If provided, matches an existing receipt to which this transaction should be added

FeeType

string

The type of the fee to apply

Fee

number

The amount of the fee for FeeType flat, or the percentage for FeeType percent

Responses

401

User is not authorized for this operation

403

User does not have the authority to perform the requested action

default

An error occurred on the backend server

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/retail/web/Company/Retail/Accounts/AccountNumber/BankDraft \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
22
 
1
{
2
  "data": {
3
    "RetailTransactionResponse": {
4
      "Status": {
5
        "StatusCode": "SUCCESS"
6
      },
7
      "FromAccount": {
8
        "AccountNumber": 100,
9
        "AvailableBalance": 2000,
10
        "LedgerBalance": 2000,
11
        "AvailableBalanceToday": 2000,
12
        "LedgerBalanceToday": 2000
13
      },
14
      "TransactionDate": "2019-04-10",
15
      "TransactionSequence": 1,
16
      "ReceiptNumber": 10,
17
      "SourceOfFundsLimit": 5000,
18
      "SourceOfFundsPrint": true,
19
      "ReferenceID": "Transfer from Account 123"
20
    }
21
  }
22
}

200Success

400Unable to understand the request, due to invalid syntax

404The requested resource could not be found