Skip to main content

kobana banking edi

EDI (EDI boxes)

Commands of kobana banking edi. Every global option (Global options) applies here.

CommandHTTPDescription
edi boxes listGET /v2/edi/edi_boxesList Mailboxes
edi boxes createPOST /v2/edi/edi_boxesCreate Mailbox
edi boxes getGET /v2/edi/edi_boxes/{uid}View Mailbox
edi boxes updatePUT /v2/edi/edi_boxes/{uid}Update Mailbox

edi boxes list​

List Mailboxes

kobana banking edi boxes list [OPTIONS]

GET /v2/edi/edi_boxes

Lists Mailboxes.

Query parameters

NameTypeRequiredDescription
resource_typestringnoFilter by Resource Type. Billing Portfolio (charge.bank_billet_account) or Financial Account (financial.account).
per_pageintegernoNumber of records per page. Maximum of 50.
pageintegernoPage number.

Responses

HTTPDescription
200Mailboxes found.

edi boxes create​

Create Mailbox

kobana banking edi boxes create [OPTIONS]

POST /v2/edi/edi_boxes

Creates a new Mailbox.

Request body

The body is not a plain object (or has variants). See kobana schema banking.edi.boxes.create.

Responses

HTTPDescription
201Mailbox created
422Validation failure

edi boxes get​

View Mailbox

kobana banking edi boxes get [UID] [OPTIONS]

GET /v2/edi/edi_boxes/{uid}

Consults information of a specific Mailbox.

Path arguments: uid

Responses

HTTPDescription
200Mailbox found
404Mailbox not found

edi boxes update​

Update Mailbox

kobana banking edi boxes update [UID] [OPTIONS]

PUT /v2/edi/edi_boxes/{uid}

Updates a specific Mailbox.

Path arguments: uid

Request body

The body is not a plain object (or has variants). See kobana schema banking.edi.boxes.update.

Responses

HTTPDescription
200Mailbox updated
404Mailbox not found
422Validation failure