Update conversion rule - Payward Developer Documentation

curl --request PUT \
  --url https://api.services.payward.com/v1/accounts/{account_id}/conversions/{conversion_rule_id} \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Renamed EUR autoramp",
  "to": {
    "symbol": "USDC",
    "type": "wallet",
    "wallet": {
      "via": "polygon",
      "address": "0xabcdef1234567890abcdef1234567890abcdef12"
    }
  },
  "status": "paused"
}
'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Renamed EUR autoramp",
    "from": {
      "symbol": "EUR",
      "type": "bank",
      "bank_account": {
        "via": "sepa",
        "payee_name": "Delta Commerce B.V.",
        "bank_address": "Borschestraat 12, Amsterdam",
        "payee_address": "71 Sir John Rogerson's Quay, Dublin, D02 R296, Ireland"
      }
    },
    "to": {
      "symbol": "USDC",
      "type": "wallet",
      "wallet": {
        "via": "polygon",
        "address": "0xabcdef1234567890abcdef1234567890abcdef12"
      }
    },
    "status": "paused",
    "created_at": "2026-05-25T10:30:00Z",
    "updated_at": "2026-05-25T11:00:00Z"
  }
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 404,
    "instance": "<string>",
    "code": "not_found",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 409,
    "instance": "<string>",
    "code": "rule_already_deleted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

PUT

accounts

{account_id}

conversions

{conversion_rule_id}

curl --request PUT \
  --url https://api.services.payward.com/v1/accounts/{account_id}/conversions/{conversion_rule_id} \
  --header 'API-Key: <api-key>' \
  --header 'API-Nonce: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Renamed EUR autoramp",
  "to": {
    "symbol": "USDC",
    "type": "wallet",
    "wallet": {
      "via": "polygon",
      "address": "0xabcdef1234567890abcdef1234567890abcdef12"
    }
  },
  "status": "paused"
}
'

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Renamed EUR autoramp",
    "from": {
      "symbol": "EUR",
      "type": "bank",
      "bank_account": {
        "via": "sepa",
        "payee_name": "Delta Commerce B.V.",
        "bank_address": "Borschestraat 12, Amsterdam",
        "payee_address": "71 Sir John Rogerson's Quay, Dublin, D02 R296, Ireland"
      }
    },
    "to": {
      "symbol": "USDC",
      "type": "wallet",
      "wallet": {
        "via": "polygon",
        "address": "0xabcdef1234567890abcdef1234567890abcdef12"
      }
    },
    "status": "paused",
    "created_at": "2026-05-25T10:30:00Z",
    "updated_at": "2026-05-25T11:00:00Z"
  }
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 404,
    "instance": "<string>",
    "code": "not_found",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 409,
    "instance": "<string>",
    "code": "rule_already_deleted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id

string

required

Internet International Bank Account Number identifying the PWS account the conversion rule belongs to.

Required string length: 14 - 42

conversion_rule_id

string<uuid>

required

Conversion rule identifier.

Body

application/json

Request to update an existing conversion rule.

Full-state replacement (matching the upstream contract): the supplied to, name, and status replace the conversion rule's current values. The source side (from) is immutable — re-create the conversion rule to change input asset, rail, or source type.

ConversionEndpoint · object

required

Destination side. Wallet destinations require wallet. Bank destinations require bank_account, carrying either routing details or an account_link_id.

ConversionEndpoint
ConversionEndpoint
ConversionEndpoint

Show child attributes

status

enum<string>

required

New lifecycle status. Must be active or paused; soft-delete via the delete endpoint when it lands.

Available options:

active,

paused

name

string

New partner-facing label for the conversion rule. This is a full replacement: omit to clear the existing label, send the current label to keep it.

Required string length: 1 - 128

Response

Successful response

data

ConversionRule · object

required

The updated conversion rule.

Show child attributes

⌘I