Cowdidocs
API ReferenceFinancing

List financing documents for a merchant

GET
/v1/financing/merchants/{merchantId}/documents

Authorization

Cowdi_Sales_KYC_financingBearerAuth
AuthorizationBearer <token>

User JWT for the invoice-financing surface, verified against a configured trusted issuer. Organization-scoped permissions come from the token; merchant-scoped permissions are checked with the resource-access provider selected from that verified issuer.

In: header

Path Parameters

merchantId*string

Backend merchant id.

Length1 <= length <= 255

Query Parameters

size?string

Page size from 1 to 100. Defaults to 20.

Match^\d+$
after?string

Opaque cursor for the next page. Mutually exclusive with before.

before?string

Opaque cursor for the previous page. Mutually exclusive with after.

type?string

Value in

  • "INVOICE"
  • "DELIVERY_NOTE"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/financing/merchants/string/documents"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "INVOICE",      "url": "http://example.com",      "file_name": "string",      "content_type": "image/jpeg",      "size_bytes": 1,      "uploaded_at": "2019-08-24T14:15:22Z"    }  ],  "links": {    "next": "string",    "prev": "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"    }  ]}
{  "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"    }  ]}