API Keys

Create API key

Create an API key. The secret is returned only once.

post/api-keys

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Request body

Response

Successful Response

Changes

Changed in 12 of the 50 revisions of this API.3144

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read payment_intents.create card_payments.read refunds.read refunds.create chargebacks.read chargebacks.respond mandates.read enrollment.read to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read payment_intents.create card_payments.read refunds.read refunds.create voice_sessions.read voice_sessions.create chargebacks.read chargebacks.respond mandates.read enrollment.read

      request-property-default-value-changed

    • ○

      added the new voice_sessions.create enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new voice_sessions.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read card_payments.read refunds.read refunds.create chargebacks.read mandates.read enrollment.read to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read payment_intents.create card_payments.read refunds.read refunds.create chargebacks.read chargebacks.respond mandates.read enrollment.read

      request-property-default-value-changed

    • ○

      added the new chargebacks.respond enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new payment_intents.create enum value to the request property ///

      request-property-enum-value-added

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read card_payments.read refunds.read chargebacks.read mandates.read enrollment.read to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read card_payments.read refunds.read refunds.create chargebacks.read mandates.read enrollment.read

      request-property-default-value-changed

    • ○

      added the new refunds.create enum value to the request property ///

      request-property-enum-value-added

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create payment_intents.read card_payments.read refunds.read chargebacks.read mandates.read enrollment.read

      request-property-default-value-changed

    • ○

      added the new card_payments.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new chargebacks.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new enrollment.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new mandates.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new payment_intents.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new refunds.read enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.balance wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • ○

      added the new wallets.balance enum value to the request property ///

      request-property-enum-value-added

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.deposit wallets.transfer wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • ○

      added the new wallets.deposit enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new wallets.transfer enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 089aed4017a823See the full diff
    • ▲

      removed the enum value direct_payments.create of the request property ///

      request-property-enum-value-removed

    • ▲

      removed the enum value direct_payments.read of the request property ///

      request-property-enum-value-removed

    • ○

      the request property default value changed from party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct_payments.create direct_payments.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create to party.read party.update invite.read invite.create invite.update invite.delete membership.create membership.read membership.update membership.delete payments.create payments.read external_parties.create external_parties.read direct.create direct.read external_accounts.create wallets.read wallets.create wallets.update wallets.delete wallets.fund wallets.withdraw delegations.read delegations.create delegations.update delegations.delete api_keys.read api_keys.create api_keys.delete agents.read agents.create agents.update agents.delete disputes.read disputes.create

      request-property-default-value-changed

    • ○

      added the new direct.create enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new direct.read enum value to the request property ///

      request-property-enum-value-added