CAcardda
Bank transaction

Update one

Updates the editable fields of a bank transaction. For company users only comments and metadata can be modified — every other field (amount, recipient, status, ...) is managed by the banking flow and is immutable here.

patch/v1/banking/bank_transactions/{bank_transaction_id}

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_transactions/{bank_transaction_id}
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1banking~1bank_transactions~1%7Bbank_transaction_id%7D/get/parameters/1 (unresolved $ref)

Request body

commentsstring

Free-text comments attached to the transaction.

metadataobject

Arbitrary JSON metadata to attach to the transaction.

Example request

{
  "comments": "Revisar antes de aprobar"
}

Response

Body of the updated bank transaction.

idstring uuid required

Unique identifier for the transaction

external_idstring

The ID assigned to the transaction in the bank systems

sender_idstring uuid required

The ID of the bank account that will send the payment

recipient_idstring uuid required

The ID of the bank recipient that will receive the payment

bank_payroll_idstring uuid nullable

The ID of the payroll this transaction belongs to, if any

lbtrboolean

This attribute indicates that a transaction does not have an amount limit. Only available at Banco de Chile and Santander

holder_idstring uuid

The ID of the company that owns this bank transaction

status'draft' | 'enqueued' | 'dequeued' | 'preauthorized' | 'declined' | 'approved' required

Current status of the transaction

transition'enqueue' | 'dequeue' | 'authorize' | 'preauthorize' | 'remove'

Current transition being processed for the transaction

descriptionstring

Description of the transaction

raw_datastring nullable

The raw data stored from the banks

metadataobject

Additional metadata for the transaction

receiptboolean

Indicates whether the transaction's receipt is available

payablesobject[]

List of invoices paid with this transaction (only available if pay product is activated)

amountinteger required

Amount of the transaction in cents

decline_motivestring

Reason for declining the transaction if it was declined

bank_errorsItems[] (unresolved $ref)

List of errors returned by the bank for this transaction

created_atstring date-time

Timestamp when the transaction was created

updated_atstring date-time

Timestamp when the transaction was last updated

authorized_atstring date-time

Timestamp when the transaction was authorized

enqueued_atstring date-time

Timestamp when the transaction was enqueued

idempotency_idstring nullable

Unique identifier to prevent duplicate transactions

Changes

No recorded changes to this operation across all 1 revision of this API.