Meta-data
The method allows you to set the meta-data for the address. The field type is free, you can set any value
Examples of the request body:
{
"id": "...",
"meta": 199
}
{
"id": "...",
"meta": [1,2,3,4]
}
{
"id": "...",
"meta": "some str"
}
{
"id": "...",
"meta": ["one", "two"]
}
{
"id": "...",
"meta": {
"arr": ["1","2"],
" some": "field"
}
}
{
"id": "...",
"meta": null
}
Header parameters
x-api-public-keystringOptional
Public API-key
x-api-signaturestringOptional
Signing the request body with a private API-key
Content-typestringOptionalExample:
Request content type
application/json
Body
idstringRequiredExample:
ID of the address in the system
dd2bfee3-1dfa-4b0c-bb9c-eeebe1321bec
metaobject | array | string | nullRequiredExample:
some meta-data, allow free format (string, array, object etc)
Responses
200Success
application/json
post
POST /api-gateway/addresses/set-meta HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 116
{
"id": "dd2bfee3-1dfa-4b0c-bb9c-eeebe1321bec",
"meta": "some meta-data, allow free format (string, array, object etc)"
}
200Success
{
"success": true,
"response": null
}
Last updated