atlas

Runs the settlement job for the given merchant

Note: this endpoint is idempotent, safe to re-run

post/atlas/v1/jobs/settlements/{merchantId}

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/jobs/settlements/{merchantId}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

merchantIdstring required

merchantId

Request body

targetSettlementDatestring YYYY-MM-DD
transactionDatestring YYYY-MM-DD

Response

success

codeinteger

Code is the http status code

messagestring

Message is the message to return in response body

Changes

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