Create new refunds. - Apipagos v2

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:

description

string

write-onlyoptional

Example:

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum

name

string

optional

config_code

string

optional

title

string

optional

status_code

enum<integer> <int32>

write-onlyoptional

>= 0

Allowed values:

01234567891011121399

Default:

0

Examples:

01234567891011121399

batch

string

optional

transaction_type

string

optional

token

string

optional

amount

number <float32>

write-onlyoptional

>= 0<= 10000

refund_date

string <date>

optional

scheduled_date

string <date>

optional

field_1

string

optional

Match pattern:

[0-9]+

field_2

string

optional

Match pattern:

[0-9]+

field_3

string

optional

>= 11 characters<= 11 characters

Match pattern:

(20|23|24|25|26|27|30)[0-9]*

Example

[
  {
    "amount": "5.00",
    "batch": "test",
    "config_code": "fffff",
    "description": null,
    "field_1": "4568",
    "field_2": "444",
    "field_3": "20294687914",
    "integrity_code": "abcsadasdd",
    "name": "Refund de asdasd 2",
    "refund_date": "2024-02-22T06:37:11.000Z",
    "request_date": "2024-08-28T07:25:04.000Z",
    "scheduled_date": "2024-10-07T05:15:50.000Z",
    "status_code": 0,
    "title": "REINTEGRO",
    "token": "test",
    "transaction_type": "test"
  }
]

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/refunds' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '[
    {
        "amount": "5.00",
        "batch": "test",
        "config_code": "fffff",
        "description": null,
        "field_1": "4568",
        "field_2": "444",
        "field_3": "20294687914",
        "integrity_code": "abcsadasdd",
        "name": "Refund de asdasd 2",
        "refund_date": "2024-02-22T06:37:11.000Z",
        "request_date": "2024-08-28T07:25:04.000Z",
        "scheduled_date": "2024-10-07T05:15:50.000Z",
        "status_code": 0,
        "title": "REINTEGRO",
        "token": "test",
        "transaction_type": "test"
    }
]'

Responses

🟢200OK

application/json

Body

data

array [object {1}]

optional

Example:

[{"amount":"<string>","batch":"<string>","code":"<string>","config_code":"<string>","created_at":"<dateTime>","description":"<string>","field_1":"<string>","field_2":"<string>","field_3":"<string>","id":"<integer>","integrity_code":"<string>","name":"<string>","refund_date":"<dateTime>","request_date":"<dateTime>","scheduled_date":"<dateTime>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"status_log":"<string>","title":"<string>","token":"<string>","transaction_type":"<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":"Other","nationality":"<string>","profile_photo_url":"<string>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"type":"f","updated_at":"<dateTime>"}},{"amount":"<string>","batch":"<string>","code":"<string>","config_code":"<string>","created_at":"<dateTime>","description":"<string>","field_1":"<string>","field_2":"<string>","field_3":"<string>","id":"<integer>","integrity_code":"<string>","name":"<string>","refund_date":"<dateTime>","request_date":"<dateTime>","scheduled_date":"<dateTime>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"status_log":"<string>","title":"<string>","token":"<string>","transaction_type":"<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":"Widowed","nationality":"<string>","profile_photo_url":"<string>","status":{"action":"none","code":"<integer>","description":"<string>","label":"<string>"},"type":"f","updated_at":"<dateTime>"}}]

code

string

required

message

string

optional

Example:

Example

{
  "data": [
    {
      "code": "amet eiusmod tempor officia"
    }
  ],
  "message": "At expedita perferendis error nihil. Adipisci dolor vitae nisi nisi unde necessitatibus aut. Vel temporibus unde explicabo incidunt error ipsam ut perferendis corporis. Perspiciatis labore voluptates incidunt ipsa nemo necessitatibus."
}