action velopayments_create_quote_for_payout_v3 {
label: "Create a quote for the payout"
description: "Create quote for a payout"
provider: velopayments
method: POST
path: "/v3/payouts/{payoutId}/quote"
encoding: json
input: {
type: "object"
properties: {
payoutId: {
type: "string"
format: "uuid"
}
}
required: ["payoutId"]
additionalProperties: false
}
output: {
type: "object"
properties: {
fxSummaries: {
type: "array"
items: {
type: "object"
required: ["creationTime", "fundingStatus", "paymentCurrency", "quoteId", "rate", "sourceCurrency", "status", "totalPaymentAmount", "totalSourceAmount"]
properties: {
creationTime: {
type: "string"
format: "date-time"
description: "Timestamp of when the quote was created"
}
expiryTime: {
type: "string"
format: "date-time"
description: "The timestamp for when the quote will expire"
}
fundingStatus: {
type: "string"
description: "Current status of the funding associated with this quote. One of the following values: UNFUNDED, INSTRUCTED, FUNDED"
}
invertedRate: {
type: "number"
format: "float"
description: "The inverse conversion rate (from paymnent currency to source currency)"
}
paymentCurrency: {
type: "string"
description: "Valid ISO 4217 3 letter currency code. See the ISO specification for details."
}
quoteId: {
type: "string"
format: "uuid"
description: "The id of the created quote"
}
rate: {
type: "number"
format: "float"
description: "The conversion rate (from the source currency to the payment currency)"
}
sourceCurrency: {
type: "string"
description: "Valid ISO 4217 3 letter currency code. See the ISO specification for details."
}
status: {
type: "string"
description: "Current status of the fx quote. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED, REJECTED"
}
totalPaymentAmount: {
type: "integer"
description: "The amount (in minor units) that the payee will receive"
}
totalSourceAmount: {
type: "integer"
description: "The amount (in minor units) that will be paid from the source account"
}
}
}
}
}
}
}