Cowdidocs
API ReferenceInvoice financing

Remove a merchant payout instrument

DELETE
/v1/financing/merchants/{merchantId}/bank-details/{bankDetailId}

Removes a payout instrument the merchant no longer uses, freeing a slot under the organization’s payout-instrument limit. Requires the same merchant:financing.bank_details:write permission as registering one. Loan applications already submitted are unaffected: they carry their own copy of the destination they were submitted with.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Path Parameters

merchantId*string

Canonical sales-app merchant id, shared with Core. Legacy ids remain readable.

Length1 <= length <= 255
bankDetailId*string

Payout instrument id.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/financing/merchants/01JZQ5W7M5Y83M6F1D6E0A2K8N/bank-details/550e8400-e29b-41d4-a716-446655440000"
Empty
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}

Register a merchant payout instrument POST

Creates an unverified payout instrument. Requires the dedicated merchant:financing.bank_details:write permission, distinct from invoice/document writes.

List financing documents for a merchant GET

Returns a page of a merchant’s active financing documents, newest first, optionally filtered by `type`. Requires `merchant:financing.documents:read` on the merchant; an organization-scoped role can grant that same permission across every merchant it manages. Each document carries a short-lived presigned `url` for download; an impersonated caller gets `url` masked.