Apipagos v2
  1. Get
Apipagos v2
  • Apipagos Extras
    • Cbu Cvu Validation
      GET
    • Credit Card Bin Validations
      GET
  • Apipagos Core
    • Contracts
      • Create
        • Create new contracts.
        • Create new contract extras.
      • Get
        • Display a listing of contracts.
        • Get contract by code or Id.
        • Get contract extra by ID.
      • Update
        • Updates contracts.
        • Updates contract extras.
        • Update single contract
    • Documents
      • Create
        • Create new documents.
        • Create documents new payment instances.
        • Create documents new life cycles.
      • Get
        • Display the life cycle of the document.
          GET
        • Display a listing of documents.
          GET
        • Display the payment instances of the document.
          GET
        • Display the specified document.
          GET
      • Update
        • Update payment instances of documents.
        • Update cycle of documents.
        • Update documents.
        • Update Single Document
    • Refunds
      • Get
        • Display a listing of refunds.
        • Get refunds by code.
      • Create
        • Create new refunds.
      • Update
        • Update refunds.
        • Update single refund
    • Subscriptions
      • Create
        • Create new subscriptions.
      • Get
        • Display a listing of subscriptions.
        • Get a subscription by code.
      • Update
        • Update subscriptions.
        • Update Single Subscription
    • Transactions
      • Create
        • Create new transactions.
      • Get
        • Display a listing of transactions.
        • Get a transaction by code.
      • Update
        • Update transactions.
        • Update Single Transaction
    • Publications
      • Create
        • Create new publications
      • Get
        • Display a listing of publications.
        • Get publication by code.
    • Users
      • Create
        • Create new users.
        • Create new users fiscal data.
        • Create new users addresses.
        • Create new users identities.
        • Create new users payment methods.
      • Get
        • Display a listing of the users.
        • Get a user by code.
      • Update
        • Update users.
        • Update Single User
    • Location
      • Get Countries
      • Get Country Provinces
      • Get Province Locations
    • Tenant info
      GET
    • AFIP
      GET
  1. Get

Display a listing of documents.

Testing
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
GET
/documents
apipagosinformationdocuments
Display a listing of documents.

Request

Authorization
Add parameter in header
Company-Token
Example:
Company-Token: ********************
Header Params
Accept
string 
optional
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.test.apipagos.com/api/v2/apipagos/documents' \
--header 'Accept: application/json' \
--header 'Company-Token;'

Responses

🟢200OK
application/json
Body
allOf {2} 
optional
object 
optional
data
array[object (Document) {14}] 
required
object (Resource Paginated) 
optional
links
object 
required
meta
object 
required
message
string 
optional
Example
{
    "data": [
        {
            "code": "ea nisi",
            "type_code": "Ut eu dolor aliquip",
            "title": "voluptatem neque adipisci",
            "currency_code": "AWG",
            "amount": "938.69",
            "parent": {
                "code": "minim sit",
                "type_code": "velit labore in",
                "title": "eligendi adipisci pariatur",
                "currency_code": "VND",
                "amount": "131.94",
                "parent": {},
                "integrity_code": "officia velit Lorem fugiat",
                "status": {
                    "code": 2,
                    "label": "matrix",
                    "description": "Sipes SAS",
                    "action": "showPopup"
                },
                "field_1": "pariatur commodo dolore nisi quis",
                "field_2": "ea irure minim eu",
                "field_3": "aliquip adipisicing elit",
                "user": {
                    "code": "mollit cillum sint aliqua quis",
                    "correlation_id": "magna ut nisi in sit",
                    "company_id": 19677770,
                    "type": "j",
                    "email": "[email protected]",
                    "email_verified_at": "2024-03-14T08:50:32.493Z",
                    "first_name": "Rylee",
                    "last_name": "Morar",
                    "field_1": "099",
                    "field_2": "4444",
                    "field_3": "65452",
                    "profile_photo_url": "https://loremflickr.com/640/480/abstract",
                    "birthdate": "1981-07-13T01:04:14.628Z",
                    "birth_country": "ullamco fugiat sunt",
                    "nationality": "Lorem dolore",
                    "gender": "Male",
                    "marital_status": "Widowed",
                    "status": {
                        "code": 3,
                        "label": "incremental",
                        "description": "middleware",
                        "action": "showHelp"
                    },
                    "created_at": "2024-03-14T14:27:24.311Z",
                    "updated_at": "2024-03-14T10:22:32.235Z"
                },
                "created_at": "2024-03-14T15:15:12.619Z",
                "updated_at": "2024-03-13T18:24:53.358Z"
            },
            "integrity_code": "esse veniam nostrud culpa",
            "status": {
                "code": 8,
                "label": "Washington",
                "description": "radical",
                "action": "showHelp"
            },
            "field_1": "do commodo dolore consectetur est",
            "field_2": "sunt qui do",
            "field_3": "commodo Ut fugiat voluptate non",
            "user": {
                "code": "reprehenderit dolor pariatur cillum",
                "correlation_id": "reprehenderit consectetur",
                "company_id": 55038504,
                "type": "j",
                "email": "[email protected]",
                "email_verified_at": "2024-03-13T19:13:25.973Z",
                "first_name": "Elijah",
                "last_name": "Gulgowski",
                "field_1": "099",
                "field_2": "4444",
                "field_3": "62054",
                "profile_photo_url": "https://loremflickr.com/640/480/nature",
                "birthdate": "2001-12-13T05:18:34.652Z",
                "birth_country": "amet est cillum cupidatat dolor",
                "nationality": "nulla qui",
                "gender": "Other",
                "marital_status": "Single",
                "status": {
                    "code": 9,
                    "label": "Southeast",
                    "description": "program",
                    "action": "stopExecution"
                },
                "created_at": "2024-03-13T19:57:34.183Z",
                "updated_at": "2024-03-13T20:55:37.609Z"
            },
            "created_at": "2024-03-13T23:23:36.129Z",
            "updated_at": "2024-03-14T02:59:07.679Z"
        }
    ],
    "links": {
        "first": "http://white-bore.net",
        "last": "http://warm-exaggeration.info",
        "prev": null,
        "next": "quis reprehenderit"
    },
    "meta": {
        "current_page": 2,
        "last_page": 6,
        "links": [
            {
                "url": "https://conventional-web.org",
                "label": "esse",
                "active": false
            }
        ],
        "path": "dolor commodo incididunt nisi veniam",
        "per_page": 15,
        "from": 15,
        "to": 30,
        "total": 90
    },
    "message": "Nesciunt mollitia tenetur consequatur perferendis. Quibusdam ipsa nam aliquid illo suscipit quibusdam sapiente. Harum praesentium id ipsum cupiditate dicta sequi eveniet."
}
Modified at 2024-04-04 20:38:46
Previous
Display the life cycle of the document.
Next
Display the payment instances of the document.
Built with