Skip to content

Create an adjustment

POST
/v1/admin/payouts/payout-entities/{payout_entity_id}/adjustments/

Adds a credit (positive amount) or a debit (negative amount) to the next payout. The adjustment is pending until a payout applies it.

Authorization

apiKey
headerAuthorizationBasic <token>

HTTP Basic authentication with an admin API key as the username and an empty password.

Path Parameters

payout_entity_id*string

The ID of the payout entity.

Formatuuid

Request Body

application/json
  1. body
amount*integer

Amount in the smallest currency unit. Positive credits the merchant, negative debits. Not 0.

currency*string

ISO 4217 currency code. Only EUR is supported.

description*string
Length1 <= length

Response Body

The adjustment is created.

curl -X POST 'https://api.example.com/v1/admin/payouts/payout-entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/adjustments/' \  --user "$API_KEY:" \  -H 'Content-Type: application/json' \  -d '{  "amount": -1250,  "currency": "EUR",  "description": "Correction of the October fees"}'
Empty