Update cycle of documents.

Request

Authorization

Add parameter in header

Company-Token

Example:

Company-Token: ********************

Header Params

Accept

string

optional

Example:

application/json

Body Params application/json

document_code

string

required

description

string

optional

event

string

optional

'read','paid','refunded','chargedback','updated','expired','published','workflow'

model_type

string

optional

model_id

integer

optional

Example

{
  "document_code": "string",
  "description": "string",
  "event": "string",
  "model_type": "string",
  "model_id": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.test.apipagos.com/api/v2/apipagos/documents/life-cycle' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '{
    "document_code": "string",
    "description": "string",
    "event": "string",
    "model_type": "string",
    "model_id": 0
}'

Responses

🟢200OK

application/json

Body

data

object

optional

created_at

string

optional

Example:

description

string

optional

Example:

document

object

optional

event

string

optional

Example:

updated_at

string

optional

Example:

Example

{
  "data": {
    "created_at": "<dateTime>",
    "description": "<string>",
    "document": {
      "amount": "<string>",
      "code": "<string>",
      "created_at": "<dateTime>",
      "currency_code": "<string>",
      "field_1": "<string>",
      "field_2": "<string>",
      "field_3": "<string>",
      "id": "<integer>",
      "integrity_code": "<string>",
      "parent": {
        "value": "<Circular reference to #/components/schemas/Document detected>"
      },
      "status": {
        "action": "stopExecution",
        "code": "<integer>",
        "description": "<string>",
        "label": "<string>"
      },
      "title": "<string>",
      "type_code": "<string>",
      "updated_at": "<dateTime>",
      "user": {
        "birth_country": "<string>",
        "birthdate": "<dateTime>",
        "code": "<string>",
        "company_id": "<integer>",
        "correlation_id": "<string>",
        "created_at": "<dateTime>",
        "email": "<string>",
        "email_verified_at": "<dateTime>",
        "field_1": "<string>",
        "field_2": "<string>",
        "field_3": "<string>",
        "first_name": "<string>",
        "gender": "Female",
        "id": "<integer>",
        "last_name": "<string>",
        "marital_status": "Other",
        "nationality": "<string>",
        "profile_photo_url": "<string>",
        "status": {
          "action": "none",
          "code": "<integer>",
          "description": "<string>",
          "label": "<string>"
        },
        "type": "f",
        "updated_at": "<dateTime>"
      }
    },
    "event": "<string>",
    "updated_at": "<dateTime>"
  }
}