Skip to content

Activate or cancel contract

Request

Enable a contract to use locked in FX rates in an Account Payout.
For Account Payouts customers only.

Security
basicAuth
Path
contractIdstring, [ 1 .. 50 ] charactersrequired

Unique ID of the contract.

Example:C000000001
Headers
Acceptstringrequired
Example:application/vnd.worldpay.foreignexchange-v1+json
WP-CorrelationIdstring

Optional ID to trace requests, if not provided, it is generated.

Example:15cd16b2-7b82-41cb-9b11-21be9dacad88
Bodyapplication/vnd.worldpay.foreignexchange-v1+json
statusstringrequired

New status of the contract.

Enum:"ACTIVE""CANCELLED"
entitystringrequired

6-digit reference given to you by your Worldpay Implementation Manager during the onboarding process

Example:"100001"
{ "status": "ACTIVE", "entity": "100001" }

Responses

OK response if the request is valid

Response
No content