- Apipagos Extras
- Apipagos Core
- Contracts
- Documents
- Create
- Get
- Update
- Refunds
- Subscriptions
- Transactions
- Publications
- Users
- Location
- Tenant infoGET
- AFIPGET
Display the specified document.
Testing
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
GET
/documents/{code}
apipagosinformationdocuments{code}
Request
Authorization
Add parameter in header
Company-Token
Example:
Company-Token: ********************Path Params
code
string
required
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
data
object
required
id
integer
required
code
string
required
type
object
required
title
string
required
currency_code
string
required
amount
string
required
transactions
array [object {17}]
required
integrity_code
string
required
status
object
required
field_1
string
required
field_2
string
required
field_3
string
required
user
object
required
document_payment_instances
array[string]
required
document_lifecycles
array[string]
required
details
array [object {13}]
required
expired_at
string
required
created_at
string
required
updated_at
string
required
metadata
array[string]
required
Example
{
"data": {
"id": 12,
"code": "string",
"type": {
"type_code": "string",
"title": "string",
"description": "string",
"documents_source": "string",
"transactions_source": "string",
"program_type": "string",
"config": []
},
"title": "string",
"currency_code": "string",
"amount": "string",
"transactions": [
{
"code": "string",
"concept": "string",
"currency_code": "string",
"amount": "string",
"document_type_code": "string",
"gateway": "string",
"wallet_code": "string",
"process_id": 12,
"integrity_code": "string",
"scheduled_at": null,
"controlled_at": null,
"accredited_at": null,
"reconciled_at": null,
"charged_back_at": null,
"approved_at": null,
"created_at": "2024-04-05 10:25:41",
"updated_at": "2024-04-05 10:25:41"
}
],
"integrity_code": "string",
"status": {
"code": 5,
"label": "string",
"description": "string",
"action": "string"
},
"field_1": "string",
"field_2": "string",
"field_3": "string",
"user": {
"id": 545029,
"code": "string",
"type": "string",
"email": "string",
"email_verified_at": null,
"first_name": "string",
"last_name": "string",
"company_name": null,
"field_1": "string",
"field_2": "string",
"field_3": "string",
"profile_photo_url": null,
"birthdate": "string",
"birth_country": "string",
"nationality": "string",
"gender": "string",
"marital_status": "string",
"created_at": "2024-03-19 14:39:58",
"updated_at": "2024-03-27 10:22:36",
"addresses": [
{
"street": "string",
"street_number": "string",
"department_number": null,
"department_floor": null,
"city": "string",
"state": "string",
"zip": "string",
"type": "string",
"country_id": 1,
"province_id": 12,
"locality_id": 2366,
"deleted_at": null,
"updated_at": "2024-03-27T13:22:36.000000Z",
"created_at": "2024-03-27T13:22:36.000000Z",
"country": "string"
}
],
"identities": [
{
"identification_type_id": 1,
"id_version": "string",
"identification_number": "string",
"country_id": 1,
"issue_date": null,
"expiration_date": null,
"deleted_at": null,
"updated_at": "2024-03-27T13:22:36.000000Z",
"created_at": "2024-03-27T13:22:36.000000Z",
"type": {
"id": 1,
"name": "string",
"code": "string",
"deleted_at": null,
"updated_at": "2023-12-13T13:47:59.000000Z",
"created_at": "2023-09-25T17:52:23.000000Z"
}
},
{
"identification_type_id": 2,
"id_version": "string",
"identification_number": "string",
"country_id": 1,
"issue_date": null,
"expiration_date": null,
"deleted_at": null,
"updated_at": "2024-05-08T13:18:01.000000Z",
"created_at": "2024-03-27T13:22:36.000000Z",
"type": {
"id": 2,
"name": "string",
"code": "string",
"deleted_at": null,
"updated_at": "2023-10-19T00:17:33.000000Z",
"created_at": "2023-10-19T00:17:33.000000Z"
}
}
],
"contactInfo": [
{
"contact_type": "string",
"contact_subtype": "phone_cellphone",
"contact_detail": "+5493573414138",
"default": 1,
"is_valid": 1,
"deleted_at": null,
"updated_at": "2024-07-10T13:42:42.000000Z",
"created_at": "2024-03-27T13:22:36.000000Z"
}
],
"paymentMethods": [
{
"entity_id": 176,
"entity_code": "string",
"code": "string",
"company_id": 3,
"holder": null,
"field_1": null,
"method": "string",
"gateway_code": null,
"gateway_type": "string",
"number": "string=",
"hashed_number": null,
"visible_data": "string",
"bin": null,
"due_date": null,
"name": null,
"csv": null,
"created_at": "2024-04-05T15:00:36.000000Z",
"updated_at": "2024-05-29T20:34:05.000000Z",
"deleted_at": null
},
{
"entity_id": null,
"entity_code": null,
"code": "string",
"company_id": 3,
"holder": null,
"field_1": null,
"method": "string",
"gateway_code": "string",
"gateway_type": "string",
"number": "string",
"hashed_number": null,
"visible_data": "string",
"bin": "string",
"due_date": "string",
"name": "string",
"csv": "string",
"created_at": "2024-05-03T13:19:27.000000Z",
"updated_at": "2024-05-03T13:19:27.000000Z",
"deleted_at": null
},
{
"entity_id": 176,
"entity_code": "string",
"code": "string",
"company_id": 3,
"holder": null,
"field_1": null,
"method": "string",
"gateway_code": "string",
"gateway_type": "string",
"number": "string=",
"hashed_number": null,
"visible_data": "string",
"bin": null,
"due_date": null,
"name": null,
"csv": null,
"created_at": "2024-05-03T13:32:13.000000Z",
"updated_at": "2024-05-03T13:32:13.000000Z",
"deleted_at": null
},
],
"accounts": [],
"fiscalData": {
"condition": "string",
"occupation": "string",
"government_activity": "string",
"government_activity_id": 11,
"government_status": "string",
"category": "string",
"category_id": 10,
"subcategory": "string",
"subcategory_id": 19,
"created_at": "2024-03-27T13:22:36.000000Z",
"updated_at": "2024-05-08T13:18:00.000000Z",
"deleted_at": null
},
"validations": [
{
"validation_id": 8,
"validation_type": "profile_filled",
"log": [],
"status_code": 1,
"expiry_date": "2033-09-28 15:42:37",
"created_at": "2024-03-27T13:22:37.000000Z",
"updated_at": "2024-03-27T13:22:37.000000Z",
"deleted_at": null
},
{
"validation_id": 15,
"validation_type": "string",
"log": [],
"status_code": 1,
"expiry_date": "2033-11-09 15:38:01",
"created_at": "2024-05-08T13:18:01.000000Z",
"updated_at": "2024-05-08T13:18:01.000000Z",
"deleted_at": null
},
{
"validation_id": 63,
"validation_type": "string",
"log": {
"cuit": "string"
},
"status_code": 1,
"expiry_date": "2024-08-09 16:44:52",
"created_at": "2024-08-08T14:53:44.000000Z",
"updated_at": "2024-08-09T19:24:52.000000Z",
"deleted_at": null
}
],
"extras": [],
"company": {
"company": "string",
"name": "string",
"legal_name": "string",
"tax_id": "string",
"email": "string",
"website": "string",
"status_code": 1,
"logo": "string",
"portal_link": "string",
"validity_date": "2023-09-27T03:00:00.000000Z",
"auditor": "string",
"end_date": null,
"deleted_at": null,
"updated_at": "2023-09-29T18:08:49.000000Z",
"created_at": "2023-09-27T19:42:48.000000Z"
},
"relations": [],
"complianceExtra": [],
"representedCompanies": []
},
"document_payment_instances": [],
"document_lifecycles": [],
"details": [
{
"client_code": null,
"source_type": "string",
"source": null,
"field_4": null,
"field_5": null,
"field_6": null,
"field_7": null,
"field_8": null,
"field_9": null,
"field_10": null,
"json_1": null,
"json_2": [],
"json_3": null
}
],
"expired_at": "2024-11-25 11:45:00",
"created_at": "2024-01-05T19:18:48.000000Z",
"updated_at": "2024-05-27T19:02:11.000000Z"
},
"metadata": [
"Company documents retrieved succesfully!"
]
}