Transactions Endpoint

Understanding how the Transactions endpoint works.

The Transaction API Transactions endpoint allows transaction data for a specified bank account to be sent into MYOB Business ledgers.

API Response Codes & Error Messages

Error Response Attribute titleString Title of the error message statusString The returned HTTP status code errorsArray Contains one or many error objects externalIdString Unique financial institution account number transactionIdString Unique transaction identifier of the transaction with errors errorDetailsString Detailed error description

Single Error Message examples When a financial institution is not enabled to access this Transaction API endpoint. { "title" : "Forbidden", "status" : 403, "errors" : [ { "errorDetails" : "Institution not configured to use this endpoint" } ] }   When a request has required fields that contain invalid value in the account details or a single transaction, an element in the “errors” array will present the related transactionId and the details of any invalid field violations. { "title" : "Invalid payload for transaction request", "status" : 400, "errors" : [ { "transactionId" : "000112" "errorDetails" : "transactionTypeCode: Field is required, currency: Field is required" } ] } Multiple Error Message examples Where both account details and several transactions have violated fields, details of any field violations for the acccount and transactions are presented as an element in the “errors” array. { "title" : "Invalid payload for transaction request", "status" : 400, "errors" : [ { "externalId" : "ty79v3-452iU-7op81z-AwMDIxMj" "errorDetails" : "balanceUpdated: Must be in ISO_8601 DateTime format" }, { "transactionId" : "000113" "errorDetails" : "transactionTypeCode: Field is required, currency: Field is required" }, { "transactionId" : "000114" "errorDetails" : "narration: Field is required" } ] }