Update single refund - Apipagos v2

Request

Authorization

Add parameter in header

Company-Token

Example:

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

Path Params

code

string

required

Code related to refunds

Example:

03baaf390dcf97cfebcdb675a914acfc

Body Params application/json

Descripción del objeto

description

string

optional

name

string

optional

config_code

string

optional

title

string

optional

status_code

integer

optional

batch

string

optional

transaction_type

string

optional

amount

number

optional

amount_2

number

optional

amount_3

number

optional

amount_4

number

optional

refund_date

string

optional

scheduled_date

string

optional

field_1

string

optional

field_2

string

optional

field_3

string

optional

field_4

string

optional

field_5

string

optional

field_6

string

optional

field_7

string

optional

field_8

string

optional

field_9

string

optional

field_10

string

optional

process_id

string

optional

Example

{
  "description": "Descripción del objeto",
  "name": "Nombre del objeto",
  "config_code": "ABC123",
  "title": "Título del objeto",
  "status_code": 1,
  "batch": "Lote001",
  "transaction_type": "Tipo de transacción",
  "token": "abc123token",
  "amount": 100.5,
  "amount_2": 50.75,
  "amount_3": null,
  "amount_4": 200,
  "refund_date": "2024-12-01",
  "scheduled_date": "2024-12-31",
  "field_1": "Campo 1",
  "field_2": "Campo 2",
  "field_3": "Campo 3",
  "field_4": null,
  "field_5": "Campo 5",
  "field_6": null,
  "field_7": null,
  "field_8": "Campo 8",
  "field_9": null,
  "field_10": "Campo 10",
  "process_id": "Proc12345"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://api.test.apipagos.com/api/v2/apipagos/refunds/03baaf390dcf97cfebcdb675a914acfc' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '{
  "description": "Descripción del objeto",
  "name": "Nombre del objeto",
  "config_code": "ABC123",
  "title": "Título del objeto",
  "status_code": 1,
  "batch": "Lote001",
  "transaction_type": "Tipo de transacción",
  "token": "abc123token",
  "amount": 100.5,
  "amount_2": 50.75,
  "amount_3": null,
  "amount_4": 200.0,
  "refund_date": "2024-12-01",
  "scheduled_date": "2024-12-31",
  "field_1": "Campo 1",
  "field_2": "Campo 2",
  "field_3": "Campo 3",
  "field_4": null,
  "field_5": "Campo 5",
  "field_6": null,
  "field_7": null,
  "field_8": "Campo 8",
  "field_9": null,
  "field_10": "Campo 10",
  "process_id": "Proc12345"
}'

Responses

🟢200Success

application/json

Body

data

object

required

id

integer

required

code

string

required

description

string

required

name

string

required

company_id

integer

required

process_id

integer

required

config_code

string

required

title

string

required

status_code

integer

required

status_log

string

required

integrity_code

string

required

user_id

integer

required

batch

string

required

transaction_type

string

required

token

string

required

amount

string

required

refund_date

string

required

scheduled_date

string

required

request_date

string

required

field_1

string

required

field_2

string

required

field_3

string

required

field_4

string

required

field_5

string

required

field_6

string

required

field_7

string

required

field_8

string

required

field_9

string

required

field_10

string

required

auditor

string

required

deleted_at

string

required

created_at

string

required

updated_at

string

required

amount_2

string

required

amount_3

string

required

amount_4

string

required

status

object

required

user

string

required

histories

array [object {14}]

required

metadata

object

required

Example

{
  "data": {
    "id": 7543,
    "code": "03baaf390dcf97cfebcdb675a914acfc",
    "description": "",
    "name": "Reintegros Fondo Grupos",
    "company_id": 3,
    "process_id": 0,
    "config_code": "008",
    "title": "Reintegro de Haberes Netos",
    "status_code": 0,
    "status_log": "",
    "integrity_code": "",
    "user_id": null,
    "batch": "asd",
    "transaction_type": "10",
    "token": "******************1017",
    "amount": "0.00",
    "refund_date": "2024-12-16T18:00:00.000000Z",
    "scheduled_date": "2024-10-07T08:10:26.000000Z",
    "request_date": "2024-10-07T17:33:11.000000Z",
    "field_1": "004382",
    "field_2": "0046",
    "field_3": "27339234936",
    "field_4": "",
    "field_5": "",
    "field_6": "",
    "field_7": "",
    "field_8": "",
    "field_9": "",
    "field_10": "",
    "auditor": "apipagos",
    "deleted_at": null,
    "created_at": "2023-11-03T15:05:43.000000Z",
    "updated_at": "2024-12-26T14:45:49.000000Z",
    "amount_2": "0.00",
    "amount_3": "0.00",
    "amount_4": "0.00",
    "status": {
      "id": 100,
      "model_type": "refunds",
      "action": "none",
      "label": "Confirmado Cliente",
      "description": "Reintegro, CBU confirmado por el cliente",
      "help_id": null,
      "code": 1,
      "deleted_at": null,
      "created_at": "2023-10-25T19:15:56.000000Z",
      "updated_at": "2023-10-25T19:15:56.000000Z"
    },
    "user": null,
    "histories": [
      {
        "id": 424,
        "company_id": 3,
        "record_id": 58,
        "refunds_id": 7543,
        "user_id": 3000141,
        "type_user": "apoderado",
        "status_code": 3,
        "form_records_id": 23,
        "comments": null,
        "duedate": null,
        "auditor": "dmurua",
        "created_at": "2024-10-03T18:02:56.000000Z",
        "updated_at": "2024-10-21T16:56:21.000000Z",
        "deleted_at": null
      }
    ]
  },
  "metadata": {
    "message": "Refund updated succesfully!"
  }
}

🔴500Server Error Response