Apipagos v2
  1. Update
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.
          PUT
        • Updates contract extras.
          PUT
        • Update single contract
          PATCH
    • Documents
      • Create
        • Create new documents.
        • Create documents new payment instances.
        • Create documents new life cycles.
      • Get
        • Display the life cycle of the document.
        • Display a listing of documents.
        • Display the payment instances of the document.
        • Display the specified document.
      • 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. Update

Update single contract

Testing
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
PATCH
/contracts/{code}
Update contract by code or id.

Request

Authorization
Add parameter in header
Company-Token
Example:
Company-Token: ********************
Path Params
code
string 
required
Contract code or Id contract
Example:
code = 28c7fbfacc309631dbc4e3584c5b8fa8 / id = 132
Body Params application/json
user_id_src
integer 
optional
user_id_dst
integer 
optional
status_code
integer 
optional
title
string 
optional
description
string 
optional
expired_at
string 
optional
Example
{
  "user_id_src": 123,
  "user_id_dst": 456,
  "status_code": 1,
  "title": "Titulo de ejemplo",
  "description": "Descripción del registro",
  "expired_at": "2024-12-31T23:59:59"
}

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 PATCH 'https://api.test.apipagos.com/api/v2/apipagos/contracts/code = 28c7fbfacc309631dbc4e3584c5b8fa8 / id = 132' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '{
  "user_id_src": 123,
  "user_id_dst": 456,
  "status_code": 1,
  "title": "Titulo de ejemplo",
  "description": "Descripción del registro",
  "expired_at": "2024-12-31T23:59:59"
}'

Responses

🟢200Success
application/json
Body
data
object 
required
id
integer 
required
code
string 
required
company_id
integer 
required
user_id_src
integer 
required
user_id_dst
integer 
required
status_code
integer 
required
config_type_id
integer 
required
config_code
string 
required
circuit
null 
required
title
string 
required
description
string 
required
user_email_dst
null 
required
user_phone_dst
null 
required
expired_at
string 
required
auditor
string 
required
created_at
string 
required
updated_at
string 
required
deleted_at
null 
required
config_fields
array[string]
required
status
object 
required
user_source
object 
required
user_destiny
object 
required
signatories
array[string]
required
extras
array[string]
required
config
object 
required
metadata
object 
required
message
string 
required
Example
{
    "data": {
        "id": 248,
        "code": "28c7fbfacc309631dbc4e3584c5b8fa8",
        "company_id": 3,
        "user_id_src": 586222,
        "user_id_dst": 2035370,
        "status_code": 0,
        "config_type_id": 1,
        "config_code": "cesiones",
        "circuit": null,
        "title": "Titulo de ejemplo",
        "description": "Cesion Autoahorro",
        "user_email_dst": null,
        "user_phone_dst": null,
        "expired_at": "2024-07-18 19:55:42",
        "auditor": "apipagos",
        "created_at": "2024-06-18T22:55:42.000000Z",
        "updated_at": "2024-11-08T18:17:35.000000Z",
        "deleted_at": null,
        "config_fields": [],
        "status": {
            "id": 1,
            "model_type": "contracts",
            "action": "showHelp",
            "label": "pendiente",
            "description": "Cesión pendiente de aprobación",
            "help_id": null,
            "code": 0,
            "deleted_at": null,
            "created_at": "2023-09-22T20:06:17.000000Z",
            "updated_at": "2024-06-02T23:07:52.000000Z"
        },
        "user_source": {
            "id": 586222,
            "code": "8720fbf49733b12f93501f6c59ddeffb",
            "correlation_id": null,
            "company_id": 3,
            "process_id": 190967,
            "type": "f",
            "email": "[email protected]",
            "first_name": "MARIA JOSE PICCA CROTTO                                                         ",
            "last_name": "",
            "company_name": null,
            "field_1": "004382",
            "field_2": "0026",
            "field_3": "27275458045",
            "profile_photo_url": "000474",
            "birthdate": null,
            "birth_country": null,
            "birth_country_id": null,
            "nationality": null,
            "nationality_id": null,
            "gender": null,
            "marital_status": null,
            "status_code": 1,
            "integrity_code": "3461ce2f98d495f51349e0e34a9a5a68",
            "auditor": "file_parser",
            "deleted_at": null,
            "updated_at": "2024-03-21T15:54:39.000000Z",
            "created_at": "2024-03-21T15:54:39.000000Z",
            "email_verified_at": null,
            "addresses": [],
            "extras": [],
            "fiscal_data": null,
            "status": {
                "id": 33,
                "model_type": "users",
                "action": "none",
                "label": "Activo",
                "description": "Usuario activo",
                "help_id": null,
                "code": 1,
                "deleted_at": null,
                "created_at": "2023-09-22T20:06:17.000000Z",
                "updated_at": "2023-09-22T20:06:17.000000Z"
            }
        },
        "user_destiny": {
            "id": 2035370,
            "code": "274145bf495ed8decf74bbf046cf2e11",
            "correlation_id": null,
            "company_id": 3,
            "process_id": null,
            "type": "f",
            "email": "[email protected]",
            "first_name": "JULIETA ALMA",
            "last_name": "SCOLLO",
            "company_name": null,
            "field_1": "004270",
            "field_2": "0128",
            "field_3": "27452194452",
            "profile_photo_url": null,
            "birthdate": "2000-10-02",
            "birth_country": "2000-10-2",
            "birth_country_id": 1,
            "nationality": "Argentina",
            "nationality_id": 1,
            "gender": "Female",
            "marital_status": null,
            "status_code": 1,
            "integrity_code": null,
            "auditor": "system",
            "deleted_at": null,
            "updated_at": "2024-08-09T13:41:27.000000Z",
            "created_at": "2024-08-09T13:41:27.000000Z",
            "email_verified_at": null,
            "status": {
                "id": 33,
                "model_type": "users",
                "action": "none",
                "label": "Activo",
                "description": "Usuario activo",
                "help_id": null,
                "code": 1,
                "deleted_at": null,
                "created_at": "2023-09-22T20:06:17.000000Z",
                "updated_at": "2023-09-22T20:06:17.000000Z"
            }
        },
        "signatories": [],
        "extras": [],
        "config": {
            "id": 1,
            "company_id": 3,
            "help_id": 1,
            "table_id": 18,
            "status_code": 1,
            "config_code": "cesiones",
            "title": "Transferencias Autoahorro Volkswagen",
            "description": "",
            "program_type": "database",
            "source": "",
            "config": null,
            "auditor": "narevalo",
            "created_at": "2023-12-29T14:38:46.000000Z",
            "updated_at": "2024-09-18T18:36:44.000000Z",
            "deleted_at": null
        }
    },
    "metadata": {
        "message": "Contract updated succesfully!"
    }
}
🟠420Bad Request
🟠404Record Not Found
🔴500Server Error Response
Modified at 2024-12-20 14:45:08
Previous
Updates contract extras.
Next
Create new documents.
Built with