POST
/
v1
/
payments
curl --request POST \
  --url https://api.paywise.de/v1/payments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "claim": "7e60fd1d-575d-4043-a73d-5a2fe9049027",
  "your_reference": "eeba-3465-2debe",
  "amount": {
    "value": "149.00",
    "currency": "EUR"
  },
  "value_date": "2019-08-24",
  "metadata": [
    {
      "type": "invoice:reference",
      "value": "R23/328452398"
    }
  ]
}'
{
  "href": "<string>",
  "id": "<string>",
  "claim": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "your_reference": "<string>",
  "amount": {
    "value": "<string>",
    "currency": "EUR"
  },
  "value_date": "2023-12-25",
  "metadata": [
    {
      "type": "comment",
      "value": "<string>"
    }
  ],
  "created": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Body

A payment associated for a claim

​
claim
string
required

The ID of the claim the payment should be reported on.

​
amount
object
required

The amount of the payment.

​
value_date
string
required

The value date of the payment.

​
your_reference
string | null

Your unique reference.

Maximum length: 255
​
metadata
object[]

The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.

Metadata for payments

Response

201 - application/json

A payment associated for a claim

​
href
string
required
​
claim
string
required

The ID of the claim the payment should be reported on.

​
amount
object
required

The amount of the payment.

​
value_date
string
required

The value date of the payment.

​
created
string
required
​
id
string
​
your_reference
string | null

Your unique reference.

Maximum length: 255
​
metadata
object[]

The metadata object allows you to submit additional relevant information related to the payment as type/value pairs. You can submit an unlimited number of metadata sets.

Metadata for payments