Manage Bank Instructions

POST

/gw/api/v1/bank-instructions

POST

/gw/api/v1/bank-instructions

curl -X POST https://localhost:5000/gw/api/v1/bank-instructions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructionType": "ACH_INSTRUCTION",
  "instruction": {
    "accountId": "U223454",
    "achType": "DEBIT_CREDIT",
    "bankInstructionCode": "USACH",
    "bankInstructionName": "TestInstr",
    "clientAccountInfo": {
      "bankAccountNumber": "101267576983",
      "bankAccountTypeCode": 0,
      "bankName": "JPM Chase",
      "bankRoutingNumber": "202012983"
    },
    "clientInstructionId": 1012983,
    "creditAmount1": 1,
    "creditAmount2": 2,
    "currency": "USD",
    "pendingInstructionId": 35354345
  }
}'

{
  "status": 202,
  "instructionSetId": 2487,
  "instructionResult": {
    "clientInstructionId": 80009,
    "instructionType": "ACH_INSTRUCTION",
    "instructionStatus": "PENDING",
    "instructionId": 43092478
  }
}

Create or delete bank instructions by accountId. ACH, Open Banking, Withdrawal (against an existing Open Banking deposit), Traditional Bank Instruction Verification, Predefined Destination, and eDDA are supported for ‘Create’.

Scope: bank-instructions.write
Security Policy: Signed JWT

Create or delete bank instructions by accountId. ACH, Open Banking, Withdrawal (against an existing Open Banking deposit), Traditional Bank Instruction Verification, Predefined Destination, and eDDA are supported for 'Create'.<br><br>**Scope**: `bank-instructions.write`<br>**Security Policy**: `Signed JWT`

Authentication

AuthorizationBearer

RS256-signed JWT access token signed with your registered private key.

Path parameters

client-idstringRequired

The client's clientId

Request

This endpoint expects an object.

instructionTypeenumRequired

instructionobjectRequired

Response

Accepts request to create a new instruction asynchronously

statusdouble

HTTP status code for the request.

instructionSetIddouble

Identifier of the instruction set grouping the submitted instructions.

instructionResultobjectOptional

Result of the submitted instruction.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error