Skip to content
NimlesNimlesNimles Docs

Patch a payment

PATCH
/api/tenant/{tenantId}/Payments/{id}
curl --request PATCH \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Payments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "op": "example", "path": "example", "from": "example", "value": "example" } ]'

Applies JSON Patch operations (add, remove, replace, move, copy and test) to the members a PUT changes: /paymentOptionId, /buyer, /seller, /items, /description, /urls, /currency, /netAmount, /grossAmount and /country (also below them, e.g. /items/0/quantity). Status, processor and reference members are changed by initialize, execute and complete only. Like the PUT, a payment option the patch sets must be one of the payment’s resource group.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

The payment’s id.

tenantId
required
string format: uuid

Your tenant id.

Request Body

Section titled “Request Body”

The operations, applied in order.

Media typeapplication/json
Array<object>
object
op
required
string
>= 1 characters /^(add|remove|replace|move|copy|test)$/
path
required
string
>= 1 characters
from
string
nullable
value
nullable

Example generated

[
  {
    "op": "example",
    "path": "example",
    "from": "example",
    "value": "example"
  }
]

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
paymentOptionId
string format: uuid
orderId
string format: uuid
nullable
paymentNumber
integer format: int32
name
string
nullable
description
string
nullable
paymentType
string
nullable
status
string
nullable
buyer
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable
customerType
string
nullable
identityNumber
string
nullable
organizationName
string
nullable
firstName
string
nullable
lastName
string
nullable
email
string
nullable
phoneNumber
string
nullable
deliveryAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
billingAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
useDeliveryAddress
boolean
seller
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable
items
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
orderId
string format: uuid
nullable
orderItemId
string format: uuid
nullable
sku
string
nullable
name
string
nullable
description
string
nullable
unitNetPrice
number format: double
unitGrossPrice
number format: double
quantity
number format: double
netAmount
number format: double
vatRate
integer format: int32
nullable
grossAmount
number format: double
netAmount
number format: double
grossAmount
number format: double
currency
string
nullable
dueDate
string format: date-time
nullable
events
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
userId
string format: uuid
eventType
string
nullable
status
string
nullable
clientIpAddress
string
nullable
paymentProcessorStatus
string
nullable
message
string
nullable
urls
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
cancel
string
nullable
terms
string
nullable
checkout
string
nullable
confirmation
string
nullable
push
string
nullable
addressUpdate
string
nullable
cancellationTerms
string
nullable
countryChange
string
nullable
notification
string
nullable
shippingOptionUpdate
string
nullable
validation
string
nullable
country
string
nullable
paymentProcessor
string
nullable
htmlSnippet
string
nullable
paymentReference
string
nullable
customerReference
string
nullable
credentialReference
string
nullable
paymentProcessorStatus
string
nullable
clientSecret
string
nullable
isPayLater
boolean

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "paymentOptionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "orderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "paymentNumber": 1,
    "name": "example",
    "description": "example",
    "paymentType": "example",
    "status": "example",
    "buyer": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "customerType": "example",
      "identityNumber": "example",
      "organizationName": "example",
      "firstName": "example",
      "lastName": "example",
      "email": "example",
      "phoneNumber": "example",
      "deliveryAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "billingAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "useDeliveryAddress": true
    },
    "seller": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    },
    "items": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "orderId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "orderItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "sku": "example",
        "name": "example",
        "description": "example",
        "unitNetPrice": 1,
        "unitGrossPrice": 1,
        "quantity": 1,
        "netAmount": 1,
        "vatRate": 1,
        "grossAmount": 1
      }
    ],
    "netAmount": 1,
    "grossAmount": 1,
    "currency": "example",
    "dueDate": "2026-04-15T12:00:00Z",
    "events": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "eventType": "example",
        "status": "example",
        "clientIpAddress": "example",
        "paymentProcessorStatus": "example",
        "message": "example"
      }
    ],
    "urls": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "cancel": "example",
      "terms": "example",
      "checkout": "example",
      "confirmation": "example",
      "push": "example",
      "addressUpdate": "example",
      "cancellationTerms": "example",
      "countryChange": "example",
      "notification": "example",
      "shippingOptionUpdate": "example",
      "validation": "example"
    },
    "country": "example",
    "paymentProcessor": "example",
    "htmlSnippet": "example",
    "paymentReference": "example",
    "customerReference": "example",
    "credentialReference": "example",
    "paymentProcessorStatus": "example",
    "clientSecret": "example",
    "isPayLater": true
  }
}

204

Section titled “204”

No Content: done, with no item to return.

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Section titled “422”

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}