VEvelopaymentsapi
Payouts

Create a quote for the payout

Changed on

Create quote for a payout

post/v3/payouts/{payoutId}/quote

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

Response

Quote for payout

Example response

{
  "fxSummaries": [
    {
      "invertedRate": 1.12,
      "creationTime": "2022-10-30T09:45:09Z",
      "rate": 0.89,
      "expiryTime": "2022-10-30T09:50:09Z",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 890000,
      "paymentCurrency": "USD",
      "quoteId": "af80d455-29dd-4e72-a000-495a9829a7d0",
      "totalSourceAmount": 1000000,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    },
    {
      "invertedRate": 1.12,
      "creationTime": "2022-10-30T09:45:09Z",
      "rate": 0.89,
      "expiryTime": "2022-10-30T09:50:09Z",
      "sourceCurrency": "USD",
      "totalPaymentAmount": 890000,
      "paymentCurrency": "USD",
      "quoteId": "af80d455-29dd-4e72-a000-495a9829a7d0",
      "totalSourceAmount": 1000000,
      "fundingStatus": "FUNDED",
      "status": "QUOTED"
    }
  ]
}

Changes

  • 2c03ca69ee09Revision changes
    • info

      api tag Payouts added

    • info

      api tag Payout Service removed

  • 1e7a1734a45cRevision changes
    • info

      removed the EXECUTED enum value from the // response property for the response status

    • info

      removed the EXPIRED enum value from the // response property for the response status

    • info

      removed the FUNDED enum value from the // response property for the response status

    • info

      removed the INSTRUCTED enum value from the // response property for the response status

    • info

      removed the QUOTED enum value from the // response property for the response status

    • info

      removed the REJECTED enum value from the // response property for the response status

    • info

      removed the UNFUNDED enum value from the // response property for the response status

    • info

      removed the UNQUOTED enum value from the // response property for the response status