API Reference

Create an amendment quote

post
https://api.stage.payouts.com/conversion-amendments/quote

Required permissions for this API:

  • WRITE:FINANCE
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Currency charged on the delta that arises with the amendment. Only the currencies from the original conversion are allowed. Default will be set to the non-fixed side of the original conversion.

string
required

ID of the conversion to be amended.

metadata
object

Persisted client-supplied metadata. A metadata JSON object with a maximum of 10 key-value pairs (each key and value must be less than 255 characters).

string
required

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

string
required

Defines the type of amendment to be created. Only CANCEL is supported.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?