Sign in
contracts

Set the contractor's payout methods for a contract

put/api/v1/documents/contracts/{contract_id}/payment_methods

Path parameters

contract_idstring uuid required

Headers

x-api-keystring nullable

Request body

paymentMethodsobject[]

Response

Successful Response

idstring uuid required
clientIdstring uuid required
contractorIdstring uuid required
creatorIdstring uuid nullable
labelstring nullable
type'service' | 'employment' | 'nda' | 'contractor' | 'vendor' | 'msa' | 'other' required

What the recurring agreement is for. A label only — it drives no logic.

status'active' | 'paused' | 'completed' | 'cancelled' required

Contract status. A contract is live the moment it is created.

amountstring required
currency'USD' | 'EUR' | 'GBP' | 'JPY' | 'CHF' | 'CAD' | 'AUD' | 'NZD' | 'SEK' | 'NOK' | 'AED' | 'HKD' | 'BRL' | 'MXN' | 'USDC' | 'USDT' | 'DAI' | 'SOL' | 'BTC' | 'ETH' | 'NEAR' | 'BNB' | 'XRP' | 'ADA' | 'DOGE' | 'TRX' | 'GRAM' | 'AVAX' | 'MATIC' | 'DOT' | 'LTC' | 'LINK' | 'ARB' | 'OP' | 'SUI' required

Supported invoice/contract currencies. G10 majors + AED/HKD, plus popular crypto tokens.

priorityMethodsTransactionType[]
paymentMethodsobject[]
createdAtstring date-time required
updatedAtstring date-time required

Changes

Changed in 1 of the 4 revisions of this API.38820

  • 7ed1b58c560738820See the full diff
    • ▲

      the currency response's property type/format changed from / to string/ for status 200

      response-property-type-changed

    • ▲

      removed the required property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/clientId from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/updatedAt from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property activationAt from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property clientAcceptance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property contractorAcceptance from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property documentDownloadLink from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property documentFileName from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property documentId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property documentName from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property expirationAt from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property fields from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/clientEmail from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/comment from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/contractorEmail from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/contractorId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/discount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/emailMessage from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/invoiceDocumentId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastInvoice/anyOf[subschema #1: ContractLastInvoice]/onchainTransactionId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property period from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property signatureRequestId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property signed from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new ADA enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ADA enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AED enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ARB enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ARB enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AUD enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AVAX enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AVAX enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BNB enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BNB enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BRL enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BRL enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CAD enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CHF enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DAI enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DAI enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DOGE enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DOGE enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DOT enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new DOT enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ETH enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ETH enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new EUR enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GBP enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GRAM enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new GRAM enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HKD enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new JPY enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new LINK enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new LINK enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new LTC enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new LTC enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new MATIC enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new MATIC enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new MXN enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new MXN enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NEAR enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NEAR enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NOK enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NZD enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new OP enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new OP enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SEK enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SOL enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SUI enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new SUI enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRX enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRX enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USD enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USDC enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USDT enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new USDT enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new XRP enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new XRP enum value to the lastInvoice/anyOf[subschema #1: ContractLastInvoice]/currency response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new fednow enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hevn_transfer enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new move enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new oneclick enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pse enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new rtp enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new spei enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new subscription enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new transfers_3_0 enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ukfps enum value to the priorityMethods/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property clientAddress to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property contractorAddress to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property documents to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property schedule to the response with the 200 status

      response-optional-property-added

    • ○

      added ContractParty-Output to the client response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added ContractParty-Output to the contractor response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed ContractParty from the client response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed ContractParty from the contractor response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      removed Currency subschema #2 from the currency response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      the response property amount became required for the status 200

      response-property-became-required

    • ○

      the response property currency became required for the status 200

      response-property-became-required

    • ○

      removed the custom enum value from the type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the default_contractor enum value from the type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the milestone enum value from the type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the pending_approval_by_client enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the pending_approval_by_contractor enum value from the status response property for the response status 200

      response-property-enum-value-removed

    • ○

      response property amount list-of-types was narrowed by removing types null from media type application/json of response 200

      response-property-list-of-types-narrowed

    • ○

      the amount response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status 200

      response-property-pattern-added

    • ○

      added the required property billing to the response with the 200 status

      response-required-property-added

    • ○

      added the required property terms to the response with the 200 status

      response-required-property-added

    This revision also has 47 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog