API Documentation

Pay out of FX contract

post
https://apim.demo01.my.fivedegrees.cloud/sbx/account-fxcontract//outgoing-payment

API endpoint to pay out of an FX contract to a linked account

Path Params
string
required

The contract number

Body Params

The pay out of contract request dto

Parameters for paying out of an FX contract to a linked account

string | null

Payment currency

double
required

Payment amount

date-time | null

Payment value date. If not specified, it will be the same as current system date

date-time | null

Payment interest date. If not specified, it will be the same as value date

date-time | null

Payment clearing date. If not specified, it will be the same as value date

string | null

Reference to be stored with the payment

string | null

Free text clarification to be stored with the payment

string | null
required

Payment source. Must match a code returned by the payment sources reference data endpoint.

int32 | null

FX contract leg id. Must be specified if the contract is multi-legged

int32 | null

Optional: Payment subtype. Payment subtype can be identified by, either identifier or name

string | null

Payment subtype name. Payment subtype can be identified by, either identifier or name

string | null

End-to-end identifier, stored with all resulting movements

string | null

The account to pay to, if not set, the linked account is used

Headers
string
required
Defaults to v1

API versioning

uuid
required

Correlates HTTP requests between a client and server

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

500

Internal Server Error

Updated 7 days ago

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

Updated 7 days ago

Did this page help you?