HomeGuidesAPIsReleasesDownloadsDeveloperEvents
Log In
APIs
These docs are for v2024.02. Click to read the latest docs for v2025.03.01.

Sets the payment method for a contract.

Sets the payment method for a customer contract.
Response Code | Fault Code | Fault | Suggested User Message
------------- | ---------- | ----- | ----------------------
404 | 90041 | NoContractFoundFault | Contract ID does not exist
400 | 90017 | InvalidContractStateFault | Contract cannot be changed at this time
500 | 90061 | SystemFailureFault | System Failure, Please try again later
400 | 90025 | InvalidPaymentMethodFault | Payment Method cannot be used
400 | 90049 | PaymentMethodRequiredFault | No payment method provided for purchase

Path Params
uuid
required

The customer ID to locate contracts for.

int64
required

The contract ID to locate details for.

Body Params
int64
required

The identifier of the payment method to associate with the contract.

Headers
string

The tenant ID for which the operation is being carried out. This will be automatically generated during the authentication process.

string

The ID of a user who is performing the operation. This will be automatically generated during the authentication process.

string

The source of whether records are updated by HMAC or a USER. This will be automatically generated during the authentication process. For customers accessing the service the source will be set to CUSTOMER.

Responses

Language
URL
Choose an example:
application/json