atlas

Create a draft payout for a merchant ignoring delays and holidays

Create a draft payout for a merchant ignoring delays and holidays

post/atlas/v1/payouts

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/payouts
  • Auth: OAuth 2 (implicit, authorization URL "")

Request body

currency'THB'
merchantIdstring required
plannedPayoutAmountinteger required

Response

success

actionAtstring
actionBystring
balanceIdstring
createdBystring
expectedReceivedDatestring
failureReasonstring
idstring
merchantBankAccountIdstring
merchantBankAccountNamestring
merchantBankAccountNumberstring
merchantBankNamestring

TODO: do we need to rename this to bank code for consistency?

merchantIdstring
merchantPayoutFrequency'EVERYDAY' | 'DAILY' | 'WEEKLY' | 'NOT_APPLICABLE'
merchantRegisteredEntityNamestring
notestring
notedAtstring
notedBystring
paidOutAmountinteger
paidOutAtstring
plannedPayoutAmountinteger
plannedPayoutDatestring
refBalanceAccumulatedAmountinteger
refBalanceIdstring
status'APPROVED' | 'DRAFT' | 'FAILED' | 'PAID' | 'PARTIALLY_PAID' | 'PROCESSING' | 'REJECTED' | 'UNKNOWN'
updatedBystring

Changes

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