View Bank Instructions

POST

/gw/api/v1/bank-instructions/query

POST

/gw/api/v1/bank-instructions/query

curl -X POST https://localhost:5000/gw/api/v1/bank-instructions/query \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "instructionType": "QUERY_RECURRING_INSTRUCTIONS",
  "instruction": {
    "accountId": "U399192",
    "bankInstructionMethod": "WIRE",
    "clientInstructionId": 1012983
  }
}'

{
  "instructionResult": {
    "accountId": "U399192",
    "clientInstructionId": 12008027,
    "ibReferenceId": 0,
    "instructionId": 43104628,
    "instructionStatus": "PROCESSED",
    "instructionType": "QUERY_RECENT_INSTRUCTIONS",
    "recurringInstructions": [
      {
        "amount": 1,
        "bankInstructionMethod": "ACH",
        "bankInstructionName": "Recurring Test- cpereira",
        "currency": "USD",
        "endDate": "2024-12-12",
        "frequency": "MONTHLY",
        "requestId": 206611807,
        "startDate": "2024-06-12",
        "transactionType": "DEPOSIT"
      }
    ]
  },
  "instructionSetId": 14258,
  "status": 201
}

View active bank instructions for an accountId.

Scope: bank-instructions.read
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

Create get instruction name request body

instructionTypeenumRequired

Allowed values:

instructionobjectRequired

Response

Instruction successfully created and processed synchronously

QueryRecentRecurringEventResponseobject

Response containing recent occurrences of a recurring instruction.

QueryBankInstructionResponseobject

Response containing saved bank instructions for an account.

QueryRecurringInstructionsResponseobject

Response containing recurring instructions for an account.

Errors

400

Bad Request Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error