- Apipagos Extras
- Apipagos Core
- Contracts
- Documents
- Refunds
- Subscriptions
- Transactions
- Publications
- Users
- Location
- Tenant infoGET
- AFIPGET
Get refunds by code.
Testing
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
GET
/refunds/{code}
apipagosinformationrefunds
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/refunds/' \
--header 'Accept: application/json' \
--header 'Company-Token;'Responses
🟢200OK
application/json
Body
data
array[object (Refund) {21}]
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
config_code
string
required
name
string | null
required
title
string
required
description
string | null
required
integrity_code
string
required
status
object (System Status)
required
status_log
string | null
required
transaction_type
string
required
batch
string
required
token
string
required
amount
string
required
refund_date
string <date-time>
required
scheduled_date
string <date-time>
required
request_date
string <date-time>
required
field_1
string
required
field_2
string
required
field_3
string
required
user
object (User)
required
created_at
string <date-time>
required
updated_at
string <date-time>
required
links
object
optional
first
string
optional
Example:
<string>
last
string
optional
Example:
<string>
next
string
optional
Example:
<string>
prev
string
optional
Example:
<string>
message
string
optional
Example:
<string>
meta
object
optional
current_page
string
optional
Example:
<integer>
from
string
optional
Example:
<integer>
last_page
string
optional
Example:
<integer>
links
array [object {3}]
optional
Example:
[{"active":"<boolean>","label":"<string>","url":"<string>"},{"active":"<boolean>","label":"<string>","url":"<string>"}]
path
string
optional
Example:
<string>
per_page
string
optional
Example:
<integer>
to
string
optional
Example:
<integer>
total
string
optional
Example:
<integer>
Example
{
"data": [
{
"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>"
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
},
"message": "<string>",
"meta": {
"current_page": "<integer>",
"from": "<integer>",
"last_page": "<integer>",
"links": [
{
"active": "<boolean>",
"label": "<string>",
"url": "<string>"
},
{
"active": "<boolean>",
"label": "<string>",
"url": "<string>"
}
],
"path": "<string>",
"per_page": "<integer>",
"to": "<integer>",
"total": "<integer>"
}
}