Skip to main content
PATCH
Update Payment Code

Authorizations

Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Space-Id
string
required

The value is the tenancy parameter that Monime used to determine which space the request is intended for.

Maximum string length: 100
Pattern: ^spc-.*$

Path Parameters

id
string
required

A unique identifier for the payment code object.

Body

application/json
name
string | null

The name or intent indicating the purpose or use of the payment code.

Maximum string length: 100
isActive
boolean | null
default:true

Denotes whether the payment code is active.

status
enum<string> | null

The status of the payment code.

Available options:
cancelled
expireTime
string<date-time>

The expiration time of the payment code.

allowedProviders
string[] | null

The list of MoMo provider IDs for which the payment code is allowed to be used.

Required array length: 1 - 10 elements
metadata
object | null

The metadata for the payment code.

Response

200 - application/json

OK

success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result
object