Swaps

A Swap represents one or more purchase documents received by the organization using built-in billing in Chile.

Swap object

Attributes

Attributes
id string The unique object identifier of this swap
purchases list List of purchase objects related with this swap
local_file url URL to local format XML
receipt url URL to local format receipt XML file
reception url URL to local format reception XML file
result url URL to local format result XML file
reply_to email Email to which the response was sent
reply_by string User email who sent the response of this swap
reply_date datetime Date and time the response from this swap was sent
status string Response status of this swap. One of ERM, ACD, RCD, RFP, RFT
imported boolean Determines if the swap was imported or created from the swap box
created datetime Date and time of the creation of this swap

Swap object example

{
  "id": "swa_XlG3IObKyBTQhheBVh",
  "purchases": [
    "pur_lXwASXq0R2S29UWydk"
  ]
  "local_file": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/j80ff821-0b43-4i78-a4d8-a13775cc9045.xml",
  "receipt": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/Xh6wq867-0b43-4i78-a4d8-a13775cc9045.xml",
  "reception": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/oL6Kq31b-0b43-4i78-a4d8-a13775cc9045.xml",
  "result": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/P80wp821-0b43-4i78-a4d8-a13775cc9045.xml",
  "reply_to": "[e-mail]",
  "reply_by": "[e-mail]",
  "reply_date": "2021-06-16T14:23:24.163035-00:00",
  "status": "ERM",
  "imported": false,
  "created": "2021-06-09T00:00:24.163035-00:00"
}

List swaps

GET https://api.piriod.com/billers/built_in/swaps/

List swaps received by organization

Query Parameters

Name	Type	Description
purchase	String	Allow list filtering by specific purchase ID.

200: OK A list with swaps objects.

{
    // Response
}

Retrieve a swap

GET https://api.piriod.com/billers/built_in/swaps/{id}/

This endpoint retrieves a swap

Path Parameters

Name	Type	Description
id*	String	The unique object identifier of swap

200: OK A successful swap retrieved.

{
  "id": "swa_XlG3IObKyBTQhheBVh",
  "purchases": [
    "pur_lXwASXq0R2S29UWydk"
  ]
  "local_file": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/j80ff821-0b43-4i78-a4d8-a13775cc9045.xml",
  "receipt": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/Xh6wq867-0b43-4i78-a4d8-a13775cc9045.xml",
  "reception": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/oL6Kq31b-0b43-4i78-a4d8-a13775cc9045.xml",
  "result": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/P80wp821-0b43-4i78-a4d8-a13775cc9045.xml",
  "reply_to": "[e-mail]",
  "reply_by": "[e-mail]",
  "reply_date": "2021-06-16T14:23:24.163035-00:00",
  "status": "ERM",
  "imported": false,
  "created": "2021-06-09T00:00:24.163035-00:00"
}

Update a swap

PATCH https://api.piriod.com/billers/built_in/swaps/{id}/

This endpoint updates a swap. Only swaps without status can updated.

Path Parameters

Name	Type	Description
id*	String	The unique object identifier of swap

Request Body

Name	Type	Description
purchase*	String	Unique identifier of the purchase to which you want to accept or reject.
status	String	Response status of this swap. One of ERM, ACD, RCD, RFP, RFT

200: OK A swap correctly accepted or rejected.

{
  "id": "swa_XlG3IObKyBTQhheBVh",
  "purchases": [
    "pur_lXwASXq0R2S29UWydk"
  ]
  "local_file": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/j80ff821-0b43-4i78-a4d8-a13775cc9045.xml",
  "receipt": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/Xh6wq867-0b43-4i78-a4d8-a13775cc9045.xml",
  "reception": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/oL6Kq31b-0b43-4i78-a4d8-a13775cc9045.xml",
  "result": "https://s3.amazonaws.com/api.piriod.com/cl/exchange/local_file/P80wp821-0b43-4i78-a4d8-a13775cc9045.xml",
  "reply_to": "[e-mail]",
  "reply_by": "[e-mail]",
  "reply_date": "2021-06-16T14:23:24.163035-00:00",
  "status": "ERM",
  "imported": false,
  "created": "2021-06-09T00:00:24.163035-00:00"
}

Retrieve a swap PDF

GET https://api.piriod.com/billers/built_in/swaps/{id}/pdf/

This endpoint retrieves a PDF representation of the swap. Returns a Blob Base64 encoded.

Path Parameters

Name	Type	Description
id*	String	The unique object identifier of swap

200: OK Swap PDF representation successfully retrieved.

{
    "file": "JVBERi0xLjcKJeLjz9MKNiAwIG9iago8PCAvV..."
}