Create new documents.

Request

Authorization

Add parameter in header

Company-Token

Example:

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

Header Params

Accept

string

optional

Example:

application/json

Body Params application/json

array of:

document_parent_code

string

optional

currency_code

string

required

amount

string

required

title

string

required

type_code

string

required

field_1

string

required

field_2

string

required

field_3

string

required

status_code

enum<integer>

required

Allowed values:

12345

details

array [object {13}]

required

client_code

string

required

source_type

enum<string>

required

Allowed value:

url

source

string

required

field_4

string | null

optional

field_5

string | null

optional

field_6

string | null

optional

field_7

string | null

optional

field_8

string | null

optional

field_9

string | null

optional

field_10

string | null

optional

json_1

string | null

optional

json_2

string | null

optional

json_3

string | null

optional

payment_instances

array [object {1}]

required

amount

integer <fixed64>

required

date

string

required

date:Y-m-d

Example

[
  {
    "currency_code": "ARS",
    "amount": "938.85",
    "title": "quibusdam vitae fugiat",
    "type_code": "cuota",
    "field_1": "005976",
    "field_2": "0001",
    "field_3": "30715324594",
    "status_code": 3,
    "details": [
      {
        "client_code": "003",
        "source_type": "url",
        "source": "https://fair-emanate.info",
        "field_4": null,
        "field_5": null,
        "field_6": null,
        "field_7": null,
        "field_8": null,
        "field_9": null,
        "field_10": null,
        "json_1": "{\"foo\":\"_)f&OWD\\\\Pa\",\"bar\":\"fC7n?0XeC\\\"\",\"bike\":\"EO1>\\\"hR5(J\",\"a\":\"(VZGi_x)Oq\",\"b\":19037,\"name\":\"+m[dOpiPl9\",\"prop\":35939}",
        "json_2": "{\"foo\":12910,\"bar\":\"enc4?P21J_\",\"bike\":86525,\"a\":23684,\"b\":8364,\"name\":\"\\\\o=thTx@Ft\",\"prop\":90210}",
        "json_3": "{\"foo\":\":byv?RK)5;\",\"bar\":\"`},R2J#5Zb\",\"bike\":76659,\"a\":\"x\\\\j4cw&}m:\",\"b\":26998,\"name\":\"(\\\"|$9)l2$#\",\"prop\":\"g).T+O}Qqc\"}"
      }
    ],
    "payment_instances": [
      {
        "amount": 151.05
      }
    ]
  }
]

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.test.apipagos.com/api/v2/apipagos/documents' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '[
    {
        "currency_code": "ARS",
        "amount": "938.85",
        "title": "quibusdam vitae fugiat",
        "type_code": "cuota",
        "field_1": "005976",
        "field_2": "0001",
        "field_3": "30715324594",
        "status_code": 3,
        "details": [
            {
                "client_code": "003",
                "source_type": "url",
                "source": "https://fair-emanate.info",
                "field_4": null,
                "field_5": null,
                "field_6": null,
                "field_7": null,
                "field_8": null,
                "field_9": null,
                "field_10": null,
                "json_1": "{\"foo\":\"_)f&OWD\\\\Pa\",\"bar\":\"fC7n?0XeC\\\"\",\"bike\":\"EO1>\\\"hR5(J\",\"a\":\"(VZGi_x)Oq\",\"b\":19037,\"name\":\"+m[dOpiPl9\",\"prop\":35939}",
                "json_2": "{\"foo\":12910,\"bar\":\"enc4?P21J_\",\"bike\":86525,\"a\":23684,\"b\":8364,\"name\":\"\\\\o=thTx@Ft\",\"prop\":90210}",
                "json_3": "{\"foo\":\":byv?RK)5;\",\"bar\":\"`},R2J#5Zb\",\"bike\":76659,\"a\":\"x\\\\j4cw&}m:\",\"b\":26998,\"name\":\"(\\\"|$9)l2$#\",\"prop\":\"g).T+O}Qqc\"}"
            }
        ],
        "payment_instances": [
            {
                "amount": 151.05
            }
        ]
    }
]'

Responses

🟢200OK

application/json

Body

data

array [object {15}]

optional

Example:

[{"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":"Male","id":"<integer>","last_name":"<string>","marital_status":"Divorced","nationality":"<string>","profile_photo_url":"<string>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"type":"f","updated_at":"<dateTime>"}},{"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":"showPopup","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":"Male","id":"<integer>","last_name":"<string>","marital_status":"Single","nationality":"<string>","profile_photo_url":"<string>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"type":"f","updated_at":"<dateTime>"}}]

amount

string

optional

Example:

code

string

optional

Example:

created_at

string

optional

Example:

currency_code

string

optional

Example:

field_1

string

optional

Example:

field_2

string

optional

Example:

field_3

string

optional

Example:

id

string

optional

Example:

integrity_code

string

optional

Example:

parent

object

optional

status

object

optional

title

string

optional

Example:

type_code

string

optional

Example:

updated_at

string

optional

Example:

user

object

optional

Example

{
  "data": [
    {
      "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": "Male",
        "id": "<integer>",
        "last_name": "<string>",
        "marital_status": "Divorced",
        "nationality": "<string>",
        "profile_photo_url": "<string>",
        "status": {
          "action": "none",
          "code": "<integer>",
          "description": "<string>",
          "label": "<string>"
        },
        "type": "f",
        "updated_at": "<dateTime>"
      }
    },
    {
      "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": "showPopup",
        "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": "Male",
        "id": "<integer>",
        "last_name": "<string>",
        "marital_status": "Single",
        "nationality": "<string>",
        "profile_photo_url": "<string>",
        "status": {
          "action": "none",
          "code": "<integer>",
          "description": "<string>",
          "label": "<string>"
        },
        "type": "f",
        "updated_at": "<dateTime>"
      }
    }
  ]
}