Skip to main content
POST
Record that a deposit paid one of your remittances

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

idempotency-key
string
required
Idempotency-Key
string
required

Unique per match for this installation, kept permanently; at most 255 characters

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
bankTransactionId
string
required

The deposit this remittance arrived in (btx_…), from GET /bank-transactions

Example:

"btx_5f1c0000000040000000000000000001"

kind
enum<string>
required

What the app's remittance is

Available options:
pharmacy_remittance,
other
externalRef
string
required

The app's own identifier for the remittance this deposit paid. One active match per externalRef per installation.

Required string length: 1 - 200
Example:

"remit-2026-10-0042"

amount
string
required

Amount of the deposit allocated to this remittance: a positive decimal string, at most two decimals

Example:

"1250.00"

Response

Success