Payment - Refund

List payment document refunds

get

https://api.sandbox.trio.com.brhttps://api.qa.trio.com.brhttps://api.trio.com.br

/banking/cashout/refunds

List payment document refunds

Query parameters

virtual_account_idstring · uuidRequired

Unique identifier

from_datetimestring · date-timeOptional

Datatime schema

to_datetimestring · date-timeOptional

Datatime schema

reconciliation_idstring · uuidOptional

Unique identifier

beforestringOptional

Parameter used for pagination. It is a base64 encoded param used to access the previous page of results. It is provided alongside a metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==

afterstringOptional

Parameter used for pagination. It's a base64 encoded param used to access the previous page of results. Provided along with the data in the metadata section if there is a previous page.

Example: g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==

Responses

200

Documents

application/json

A list of payment document refunds response

401

Unauthorized

application/json

500

Internal server error

application/json

get

/banking/cashout/refunds

HTTPcURLJavaScriptPython

GET /banking/cashout/refunds?virtual_account_id=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": [
    {
      "amount": {
        "amount": 100,
        "currency": "BRL"
      },
      "bank_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "description": "description",
      "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
      "entity_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "external_id": "external_id",
      "id": "018f9cb0-8d11-f5da-31a1-0c243407d6d3",
      "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
      "origin_type": "none",
      "payment_document_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
      "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
      "reconciliation_id": null,
      "stages": [
        {
          "error_code": null,
          "error_message": null,
          "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
          "inserted_at": "2024-05-21T19:46:07.285344Z",
          "status": "created"
        }
      ],
      "status": "created",
      "timestamp": "2024-05-21T19:46:07.249436Z",
      "transaction_date": null,
      "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
    }
  ]
}

Get a payment document refund

get

https://api.sandbox.trio.com.brhttps://api.qa.trio.com.brhttps://api.trio.com.br

/banking/cashout/refunds/{id}

Get a payment document refund

Path parameters

idstring · uuidRequired

Unique identifier

Responses

200

Refund

application/json

Payment document refund response

bank_account_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Bank account ID

descriptionstringOptional

Description

end_to_end_idstringOptional

End to end ID

entity_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Entity ID

external_idstringOptional

External ID

idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Refund document ID

origin_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Origin ID

origin_typestringOptional

Origin type

payment_document_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Payment document ID

receipt_urlstringOptional

Receipt URL

reconciliation_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Reconciliation ID

statusElixir.TrioFoundationWeb.Schemas.Banking.Cashout.Refund.StatusOptional

Refund document status

timestampstring · date-timeOptional

Refund document timestamp

transaction_dateElixir.SchemaDateTime · date-timeOptional

Refund document transaction date

virtual_account_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Virtual account ID

401

Unauthorized

application/json

500

Internal server error

application/json

get

/banking/cashout/refunds/{id}

HTTPcURLJavaScriptPython

GET /banking/cashout/refunds/{id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "amount": {
    "amount": 100,
    "currency": "BRL"
  },
  "bank_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "description": "description",
  "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
  "entity_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "external_id": "external_id",
  "id": "018f9cb0-8d11-f5da-31a1-0c243407d6d3",
  "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
  "origin_type": "none",
  "payment_document_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
  "reconciliation_id": null,
  "stages": [
    {
      "error_code": null,
      "error_message": null,
      "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
      "inserted_at": "2024-05-21T19:46:07.285344Z",
      "status": "created"
    }
  ],
  "status": "created",
  "timestamp": "2024-05-21T19:46:07.249436Z",
  "transaction_date": null,
  "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
}

Search payment document refund

get

https://api.sandbox.trio.com.brhttps://api.qa.trio.com.brhttps://api.trio.com.br

/banking/cashout/refunds/search

Search payment document refund by IDs

Query parameters

end_to_end_idstringOptional

End To End ID

external_idstringOptional

External ID

from_datetimestring · date-timeOptional

Datatime schema

to_datetimestring · date-timeOptional

Datatime schema

Responses

200

Refund

application/json

Payment document refund response

bank_account_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Bank account ID

descriptionstringOptional

Description

end_to_end_idstringOptional

End to end ID

entity_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Entity ID

external_idstringOptional

External ID

idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Refund document ID

origin_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Origin ID

origin_typestringOptional

Origin type

payment_document_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Payment document ID

receipt_urlstringOptional

Receipt URL

reconciliation_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Reconciliation ID

statusElixir.TrioFoundationWeb.Schemas.Banking.Cashout.Refund.StatusOptional

Refund document status

timestampstring · date-timeOptional

Refund document timestamp

transaction_dateElixir.SchemaDateTime · date-timeOptional

Refund document transaction date

virtual_account_idElixir.TrioFoundationWeb.Schemas.UUIDOptional

Virtual account ID

401

Unauthorized

application/json

500

Internal server error

application/json

get

/banking/cashout/refunds/search

HTTPcURLJavaScriptPython

GET /banking/cashout/refunds/search HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "amount": {
    "amount": 100,
    "currency": "BRL"
  },
  "bank_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "description": "description",
  "end_to_end_id": "E44444444202405211946Dwg1pjxgehP",
  "entity_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "external_id": "external_id",
  "id": "018f9cb0-8d11-f5da-31a1-0c243407d6d3",
  "origin_id": "018f9cb0-8d11-8143-d18c-5c6cd450b608",
  "origin_type": "none",
  "payment_document_id": "018f9cb0-8d11-72dd-bb14-f82554e80999",
  "receipt_url": "https://receipts.trio.com.br/document_receipts/018f9cb0-8d11-72dd-bb14-f82554e80999/refund/018f9cb0-8d37-031e-8b99-bac2919a5033",
  "reconciliation_id": null,
  "stages": [
    {
      "error_code": null,
      "error_message": null,
      "id": "018f9cb0-8d37-031e-8b99-bac2919a5033",
      "inserted_at": "2024-05-21T19:46:07.285344Z",
      "status": "created"
    }
  ],
  "status": "created",
  "timestamp": "2024-05-21T19:46:07.249436Z",
  "transaction_date": null,
  "virtual_account_id": "018f9cb0-8d11-72dd-bb14-f82554e80999"
}