Payout requests

Create a new Payout request

post/api/atlas-payout-requests

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/atlas-payout-requests
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Query parameters

depthnumber
localestring

Request body

partnerstring required

ID of the atlas-partners

status'requested' | 'approved' | 'paid' | 'rejected' required
amountCentsnumber required

To transfer, EUR cents (sales minus clawbacks).

grossCentsnumber required

Commission of the sales covered, EUR cents.

clawbackCentsnumber nullable

Paid sales cancelled since, taken back, EUR cents.

salesCountnumber required
conversionsstring

ID of the atlas-conversions

clawbacksstring

ID of the atlas-conversions

rejectionReasonstring nullable

Required to reject. Sent to the partner.

paymentReferencestring nullable

Bank transfer reference, shown to the partner.

requestedAtstring required
decidedAtstring nullable
paidAtstring nullable
requestedBystring

ID of the atlas-accounts

decidedBystring

ID of the users

Response

Payout request object

messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.