Configure or Replace Message Signature

PUT 
/targets/:id/signature/

Creates a new signature configuration or completely replaces an existing one for the specified target. Enabling is implicit on successful creation/replacement.

Request

Path Parameters

id stringrequired

application/json

Body

required

signature_method stringrequired

The signature method to configure. Must be one of: xpay, http-v1, jwt-v1.

multipart/form-data

Body

required

signature_method stringrequired

The signature method to configure. Must be one of: xpay, http-v1, jwt-v1.

key_id stringrequired

The key ID for JWT v1 signature method.

merchant_id stringrequired

The merchant ID for JWT v1 signature method.

p12_file urirequired

Possible values: Value must match regular expression (?:p12|pfx)$

The .p12 file containing the client certificate and private key.

password stringrequired

Password to decrypt the .p12 file.

Responses

200

application/json

Schema

Schema

configured booleanrequired

Indicates if message signature is configured for the target.

enabled booleanrequired

Indicates if message signature is currently enabled for the target.

signature_method stringnullablerequired

The signature method configured for the target.
Returns null if signature is not configured.

Example (from schema)

{
  "configured": true,
  "enabled": true,
  "signature_method": "string"
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

403

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "You do not have permission to perform this action."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...