VEvelopaymentsapi
Payouts

Instruct Payout

Changed on

Instruct a payout to be made for the specified payoutId.

post/v3/payouts/{payoutId}

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

Path parameters

payoutIdstring uuid required

Id of the payout

Request body

fxRateDegradationThresholdPercentagenumber float

Halt instruction if the FX rates have become worse since the last quote. Previously called fxRateDegredationThresholdPercentage.

Example request

{
  "fxRateDegradationThresholdPercentage": 0.8008282
}

Response

HTTP 202 Accepted

Changes

  • 05c3f09fc50aRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

  • 2c03ca69ee09Revision changes
    • info

      api tag Payouts added

    • info

      api tag Payout Service removed