We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Send external metadata

Testing

POST

https://proxy-stage.peax.ch/document-partner-service/agent-api/api/v1/sources/{sourceId}/accounts/{accountPeaxId}/documents/{documentId}/metadata

documentDocumentspartner_api

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

sourceId

string

required

Example:

P324234

accountPeaxId

string

required

Example:

125.9585.3424.99

documentId

string <uuid>

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params application/json

status

enum<string>

required

<= 20 characters

Allowed values:

BOOKEDPAID

Example:

PENDING

bookingId

string

required

<= 50 characters

Example:

2435234523452345

bookingDate

string <date-time>

required

Example:

2024-06-03 13:21:00.000000

bankName

string

optional

<= 60 characters

Example:

Bank 01 AG

amount

object (AmountView)

optional

value

number

optional

currency

object (CurrencyType)

optional

Three letter currency code according to ISO 4217 alpha-3, e.g. «CHF» or «EUR»

Regular Expression Pattern: «^[A-Z]{3}$»

External References:

ISO 4217

Example

{
  "status": "PENDING",
  "bookingId": "2435234523452345",
  "bookingDate": "2024-06-03 13:21:00.000000",
  "bankName": "Bank 01 AG",
  "amount": {
    "value": 3600,
    "currency": "CHF"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://proxy-stage.peax.ch/document-partner-service/agent-api/api/v1/sources//accounts//documents//metadata' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "PENDING",
    "bookingId": "2435234523452345",
    "bookingDate": "2024-06-03 13:21:00.000000",
    "bankName": "Bank 01 AG",
    "amount": {
        "value": 3600,
        "currency": "CHF"
    }
}'

Responses

🟢200Operation successful

application/json

Body

object {0}

Example

{}

🟠400Bad request

🟠403Permission denied

🟠404Not found

🔴500Internal server error

Modified at 2024-07-23 22:05:17

Request Original Order

Upload the XML Document