Skip to main content
POST
/
v2
/
bank-transactions
/
{transaction_id}
/
discard-remittance
Discard a remittance from this bank transaction
curl --request POST \
  --url https://api.example.com/v2/bank-transactions/{transaction_id}/discard-remittance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "remittance_id": "<string>",
  "rejection_reason": "<string>",
  "delete_orphaned_payments": false
}
'
{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "errors": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ],
  "detail": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
transaction_id
string
required

Body

application/json

Request to discard a remittance from a bank transaction.

​
remittance_id
string
required

ID of the remittance to discard

​
rejection_reason
string | null

Optional reason for discarding

Maximum string length: 500
​
delete_orphaned_payments
boolean
default:false

If true, delete SUGGESTED unapproved payments that have no remaining remittances after this discard

Response

Successful Response