Pagos

https://docs.pagos.ai/
Admin
Pagos provides a comprehensive platform that aggregates payments data from multiple processors,...
Tokens:101,995
Snippets:959
Trust Score:8.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Fetch account metadata requests

Source: https://docs.pagos.ai/network-tokenization/endpoint/account

Examples of how to perform a GET request to retrieve account metadata using different programming languages.

```curl
curl --request GET \
  --url https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-id: <x-merchant-id>'
```

```python
import requests  
  
url = "https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account"  
  
headers = {  
    "x-merchant-id": "<x-merchant-id>",  
    "Authorization": "Bearer <token>"  
}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {  
  method: 'GET',  
  headers: {'x-merchant-id': '<x-merchant-id>', Authorization: 'Bearer <token>'}  
};  
  
fetch('https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>",  
    "x-merchant-id: <x-merchant-id>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("x-merchant-id", "<x-merchant-id>")  
	req.Header.Add("Authorization", "Bearer <token>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account")  
  .header("x-merchant-id", "<x-merchant-id>")  
  .header("Authorization", "Bearer <token>")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://services.sandbox.pagosapi.com/toucan/tokens/{tokenRefId}/account")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Get.new(url)  
request["x-merchant-id"] = '<x-merchant-id>'
request["Authorization"] = 'Bearer <token>'
  
response = http.request(request)
puts response.read_body
```

--------------------------------

### BIN Continuity API Request Examples

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/continuity

Examples of how to perform a GET request to the BIN continuity endpoint using various programming languages.

```curl
curl --request GET \
  --url https://parrot.sandbox.pagosapi.com/bins/continuity \
  --header 'Authorization: Bearer <token>'
```

```python
import requests  
  
url = "https://parrot.sandbox.pagosapi.com/bins/continuity"  
  
headers = {"Authorization": "Bearer <token>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};  
  
fetch('https://parrot.sandbox.pagosapi.com/bins/continuity', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://parrot.sandbox.pagosapi.com/bins/continuity",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

--------------------------------

### Fetch BIN continuity data

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/continuity

Examples of how to perform a GET request to the BIN continuity endpoint across various programming languages.

```bash
curl --request GET \
  --url https://parrot.sandbox.pagosapi.com/bins/continuity \
  --header 'Authorization: Bearer <token>'
```

```python
import requests  
  
url = "https://parrot.sandbox.pagosapi.com/bins/continuity"  
  
headers = {"Authorization": "Bearer <token>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};  
  
fetch('https://parrot.sandbox.pagosapi.com/bins/continuity', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://parrot.sandbox.pagosapi.com/bins/continuity",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://parrot.sandbox.pagosapi.com/bins/continuity"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "Bearer <token>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.get("https://parrot.sandbox.pagosapi.com/bins/continuity")  
  .header("Authorization", "Bearer <token>")  
  .asString();
```

```ruby
require 'uri'
require 'net/http'
  
url = URI("https://parrot.sandbox.pagosapi.com/bins/continuity")
  
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
  
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
  
response = http.request(request)
puts response.read_body
```

--------------------------------

### GET /bins

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-overview

Retrieves detailed information for a specific BIN/IIN.

```APIDOC
## GET /bins

### Description
Retrieves card details including brand, type, and issuing bank for a provided 6-10 digit BIN/IIN.

### Method
GET

### Endpoint
https://parrot.prod.pagosapi.com/bins

### Parameters
#### Query Parameters
- **bin** (string) - Required - The 6-10 digit BIN/IIN to look up.

### Request Example
curl --request GET \
  --url 'https://parrot.prod.pagosapi.com/bins?bin=55630400' \
  --header 'Authorization:Bearer <api_key>'

### Response
#### Success Response (200)
- **card** (object) - Contains details about the card including brand, type, product, bank, and country information.

#### Response Example
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_min": "5563040000000000000",
    "bin_max": "5563049999999999999",
    "card_brand": "MASTERCARD",
    "type": "Credit",
    "prepaid": false,
    "product": {
      "product_id": "MCF",
      "product_name": "Mastercard Corporate Fleet Card"
    },
    "bank": {
      "name": "CITIBANK N.A."
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "correlation_id": "eyJGaWxlSWQiOjI3NiwiVmVyc2lvbiI6NX0="
  }
}
```

--------------------------------

### Retrieve BIN snapshot via Go

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Use the net/http package to perform the GET request.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://parrot.sandbox.pagosapi.com/batch/files"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "Bearer <token>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

--------------------------------

### Retrieve BIN snapshot via Java

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Use the Unirest library to perform the GET request.

```java
HttpResponse<String> response = Unirest.get("https://parrot.sandbox.pagosapi.com/batch/files")  
  .header("Authorization", "Bearer <token>")  
  .asString();
```

--------------------------------

### GET /batch/files

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Retrieves a snapshot CSV file containing all BINs.

```APIDOC
## GET /batch/files

### Description
Retrieves a snapshot CSV file of all BINs.

### Method
GET

### Endpoint
https://parrot.sandbox.pagosapi.com/batch/files

### Response
#### Success Response (200)
- **type** (string) - The type of the file.
- **name** (string) - The name of the file.
- **url** (string) - The URL to download the file.
- **changes** (object) - Summary of changes in the BIN data.

#### Response Example
[
  {
    "type": "<string>",
    "name": "<string>",
    "url": "<string>",
    "changes": {
      "bins_removed": 123,
      "bins_updated": 123,
      "bins_added": 123,
      "last_update_date": "<string>",
      "sources": [
        {
          "bins_total": 123,
          "source": "<string>",
          "changes": {
            "percentage": "<string>",
            "removed": 123,
            "updated": 123,
            "added": 123
          }
        }
      ]
    }
  }
]
```

--------------------------------

### Create a Disbursement

Source: https://docs.pagos.ai/data-ingestion-api/endpoint/disbursements

Examples for sending a POST request to the disbursements endpoint across various programming languages.

```curl
curl --request POST \
  --url https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements \
  --header 'Content-Type: application/json' \
  --data '
{
  "disbursement_id": "<string>",
  "amount": 1,
  "currency": "<string>",
  "created": "<string>",
  "status": "<string>",
  "pagos_codes": {},
  "additional_data": {
    "merchant_account_id": "<string>",
    "metadata": {}
  }
}
'
```

```python
import requests  
  
url = "https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements"  
  
payload = {  
    "disbursement_id": "<string>",  
    "amount": 1,  
    "currency": "<string>",  
    "created": "<string>",  
    "status": "<string>",  
    "pagos_codes": {},  
    "additional_data": {  
        "merchant_account_id": "<string>",  
        "metadata": {}  
    }  
}  
headers = {"Content-Type": "application/json"}  
  
response = requests.post(url, json=payload, headers=headers)  
  
print(response.text)
```

```javascript
const options = {  
  method: 'POST',  
  headers: {'Content-Type': 'application/json'},  
  body: JSON.stringify({  
    disbursement_id: '<string>',  
    amount: 1,  
    currency: '<string>',  
    created: '<string>',  
    status: '<string>',  
    pagos_codes: {},  
    additional_data: {merchant_account_id: '<string>', metadata: {}}  
  })  
};  
  
fetch('https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "POST",  
  CURLOPT_POSTFIELDS => json_encode([  
    'disbursement_id' => '<string>',  
    'amount' => 1,  
    'currency' => '<string>',  
    'created' => '<string>',  
    'status' => '<string>',  
    'pagos_codes' => [  
          
    ],  
    'additional_data' => [  
        'merchant_account_id' => '<string>',  
        'metadata' => [  
                  
        ]  
    ]  
  ]),  
  CURLOPT_HTTPHEADER => [  
    "Content-Type: application/json"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

```go
package main  
  
import (  
	"fmt"  
	"strings"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements"  
  
payload := strings.NewReader("{\n  \"disbursement_id\": \"<string>\",\n  \"amount\": 1,\n  \"currency\": \"<string>\",\n  \"created\": \"<string>\",\n  \"status\": \"<string>\",\n  \"pagos_codes\": {},\n  \"additional_data\": {\n    \"merchant_account_id\": \"<string>\",\n    \"metadata\": {}\n  }\n}")  
  
	req, _ := http.NewRequest("POST", url, payload)  
  
	req.Header.Add("Content-Type", "application/json")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

```java
HttpResponse<String> response = Unirest.post("https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements")  
  .header("Content-Type", "application/json")  
  .body("{\n  \"disbursement_id\": \"<string>\",\n  \"amount\": 1,\n  \"currency\": \"<string>\",\n  \"created\": \"<string>\",\n  \"status\": \"<string>\",\n  \"pagos_codes\": {},\n  \"additional_data\": {\n    \"merchant_account_id\": \"<string>\",\n    \"metadata\": {}\n  }\n}")  
  .asString();
```

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disbursements")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Post.new(url)  
request["Content-Type"] = 'application/json'  
request.body = "{\n  \"disbursement_id\": \"<string>\",\n  \"amount\": 1,\n  \"currency\": \"<string>\",\n  \"created\": \"<string>\",\n  \"status\": \"<string>\",\n  \"pagos_codes\": {},\n  \"additional_data\": {\n    \"merchant_account_id\": \"<string>\",\n    \"metadata\": {}\n  }\n}"  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### GET /bins

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/single

Retrieves information for a specific BIN. Supports optional enhanced attributes.

```APIDOC
## GET /bins

### Description
Performs a lookup for a single BIN to retrieve card and issuer details.

### Method
GET

### Endpoint
/bins

### Parameters
#### Query Parameters
- **bin** (string) - Required - Bin number (6-10 digits)
- **enhanced** (boolean) - Optional - Set to true for enhanced attributes

### Response
#### Success Response (200)
- **card** (object) - Detailed card information including brand, type, funding source, and issuer details.

#### Error Responses
- **403** - Client not enrolled in Parrot
- **404** - BIN not found
```

--------------------------------

### BIN Lookup Response

Source: https://docs.pagos.ai/bin-data-APIs/bin-data-api-testing

Example JSON response returned by the BIN Data API in Test Mode.

```json
{
  "card": {
    "number": {
      "length": 16
    },
    "bin_length": 6,
    "pagos_bin_length": 6,
    "bin_min": "4854270000000000000",
    "bin_max": "4854279999999999999",
    "pan_or_token": "pan",
    "virtual_card": null,
    "level2": false,
    "level3": false,
    "alm": false,
    "account_updater": true,
    "domestic_only": false,
    "gambling_blocked": false,
    "issuer_currency": "USD",
    "reloadable": false,
    "additional_card_brands": [
      {
        "card_brand": "PULSE",
        "bin_max": "4854279999999999999",
        "bin_min": "4854270000000000000",
        "card_brand_product": null,
        "card_brand_bank_name": null,
        "ecom_enabled": true,
        "billpay_enabled": true
      }
    ],
    "card_brand": "VISA",
    "card_segment_type": "Business",
    "combo_card": null,
    "type": "Debit",
    "funding_source": "DEBIT",
    "prepaid": false,
    "product": {
      "product_id": "G",
      "product_name": "Visa Business"
    },
    "bank": {
      "name": "SPACE COAST CREDIT UNION",
      "phone": null,
      "url": null,
      "clean_name": "Space Coast Credit Union"
    },
    "country": {
      "alpha2": "US",
      "numeric": "840",
      "name": "UNITED STATES OF AMERICA"
    },
    "authentication": {
      "authentication_required": false,
      "authentication_name": null
    },
    "cost": {
      "interchange": {
        "regulated": false,
        "regulated_name": "GOVERNMENT EXEMPT INTERCHANGE FEE",
        "domestic": null,
        "inter": null,
        "intra": null,
        "notes": null
      }
    },
    "networkfees": {},
    "correlation_id": "eyJGaWxlSWQiOjIzMDc5LCJWZXJzaW9uIjoyNDAyfQ==",
    "issuer_supports_tokenization": null,
    "multi_account_access_indicator": "N",
    "shared_bin": false
  }
}
```

--------------------------------

### Create Inquiry Job via Go

Source: https://docs.pagos.ai/account-updater/endpoint/inquiries

Uses the standard net/http package to perform a POST request.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://services.sandbox.pagosapi.com/loon/inquiries/jobs"

	payload := strings.NewReader("{\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-merchant-id", "<x-merchant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "text/plain")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /bins/continuity

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/continuity

Retrieves historical lifecycle data for a BIN range.

```APIDOC
## GET /bins/continuity

### Description
Provides historical lifecycle data for a BIN range, including status, first and last seen dates, and detailed card attributes.

### Method
GET

### Endpoint
https://parrot.sandbox.pagosapi.com/bins/continuity

### Response
#### Success Response (200)
- **continuity** (object) - The continuity data object containing BIN lifecycle details and card metadata.
- **correlation_id** (string) - Unique identifier for the request.

#### Response Example
{
  "continuity": {
    "bin": "<string>",
    "status": "<string>",
    "first_seen_at": "<string>",
    "last_seen_at": "<string>",
    "days_active": 123,
    "card": {
      "card_brand": "<string>",
      "type": "<string>",
      "prepaid": true
    }
  },
  "correlation_id": "<string>"
}
```

--------------------------------

### Retrieve BIN snapshot via Ruby

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Use the Net::HTTP library to perform the GET request.

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://parrot.sandbox.pagosapi.com/batch/files")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Get.new(url)  
request["Authorization"] = 'Bearer <token>'  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### GET /bins/continuity

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/continuity

Retrieves historical lifecycle data for a BIN range.

```APIDOC
## GET /bins/continuity

### Description
Provides historical lifecycle data for a BIN range.

### Method
GET

### Endpoint
https://parrot.sandbox.pagosapi.com/bins/continuity
```

--------------------------------

### GET /healthcheck

Source: https://docs.pagos.ai/data-ingestion-api/endpoint/healthcheck

Checks the health status of the Pagos Ingestion API.

```APIDOC
## GET /healthcheck

### Description
Checks the health status of the Pagos Ingestion API.

### Method
GET

### Endpoint
/healthcheck

### Response
#### Success Response (200)
- **status** (string) - Indicates the service is healthy.
```

--------------------------------

### Create Dispute Record

Source: https://docs.pagos.ai/data-ingestion-api/endpoint/disputes

Examples for submitting dispute data to the Pagos API.

```bash
curl --request POST \
  --url https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disputes \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispute_id": "<string>",
  "amount": 1,
  "currency": "<string>",
  "created": "<string>",
  "transaction_id": "<string>",
  "payment_method_details": {
    "payment_method_type": "<string>",
    "card": {
      "attributes": {
        "network": "<string>",
        "type": "<string>",
        "bin": "<string>",
        "issuer_bank": "<string>",
        "issuer_country": "<string>"
      }
    }
  },
  "pagos_codes": {},
  "amount_refunded": 1,
  "transaction_order_id": "<string>",
  "dispute_response": {
    "status": "<string>",
    "reason_code": "<string>",
    "reason": "<string>"
  },
  "additional_data": {
    "merchant_account_id": "<string>",
    "order_id": "<string>",
    "acquirer_reference_number": "<string>",
    "metadata": {}
  }
}
'

```

```python
import requests  
  
url = "https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disputes"  
  
payload = {  
    "dispute_id": "<string>",  
    "amount": 1,  
    "currency": "<string>",  
    "created": "<string>",  
    "transaction_id": "<string>",  
    "payment_method_details": {  
        "payment_method_type": "<string>",  
        "card": { "attributes": {  
                "network": "<string>",  
                "type": "<string>",  
                "bin": "<string>",  
                "issuer_bank": "<string>",  
                "issuer_country": "<string>"  
            } }  
    },  
    "pagos_codes": {},  
    "amount_refunded": 1,  
    "transaction_order_id": "<string>",  
    "dispute_response": {  
        "status": "<string>",  
        "reason_code": "<string>",  
        "reason": "<string>"  
    },  
    "additional_data": {  
        "merchant_account_id": "<string>",  
        "order_id": "<string>",  
        "acquirer_reference_number": "<string>",  
        "metadata": {}  
    }  
}  
headers = {"Content-Type": "application/json"}  
  
response = requests.post(url, json=payload, headers=headers)  
  
print(response.text)
```

```javascript
const options = {  
  method: 'POST',  
  headers: {'Content-Type': 'application/json'},  
  body: JSON.stringify({  
    dispute_id: '<string>',  
    amount: 1,  
    currency: '<string>',  
    created: '<string>',  
    transaction_id: '<string>',  
    payment_method_details: {  
      payment_method_type: '<string>',  
      card: {  
        attributes: {  
          network: '<string>',  
          type: '<string>',  
          bin: '<string>',  
          issuer_bank: '<string>',  
          issuer_country: '<string>'  
        }  
      }  
    },  
    pagos_codes: {},  
    amount_refunded: 1,  
    transaction_order_id: '<string>',  
    dispute_response: {status: '<string>', reason_code: '<string>', reason: '<string>'},  
    additional_data: {  
      merchant_account_id: '<string>',  
      order_id: '<string>',  
      acquirer_reference_number: '<string>',  
      metadata: {}  
    }  
  })  
};  
  
fetch('https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disputes', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

--------------------------------

### Retrieve BIN snapshot via cURL

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Use this command to fetch the BIN snapshot file using cURL.

```bash
curl --request GET \
  --url https://parrot.sandbox.pagosapi.com/batch/files \
  --header 'Authorization: Bearer <token>'
```

--------------------------------

### Retrieve BIN snapshot via PHP

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Use the cURL extension in PHP to fetch the BIN snapshot.

```php
<?php  
  
$curl = curl_init();  
  
curl_setopt_array($curl, [  
  CURLOPT_URL => "https://parrot.sandbox.pagosapi.com/batch/files",  
  CURLOPT_RETURNTRANSFER => true,  
  CURLOPT_ENCODING => "",  
  CURLOPT_MAXREDIRS => 10,  
  CURLOPT_TIMEOUT => 30,  
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,  
  CURLOPT_CUSTOMREQUEST => "GET",  
  CURLOPT_HTTPHEADER => [  
    "Authorization: Bearer <token>"  
  ],  
]);  
  
$response = curl_exec($curl);  
$err = curl_error($curl);  
  
curl_close($curl);  
  
if ($err) {  
  echo "cURL Error #:" . $err;  
} else {  
  echo $response;  
}
```

--------------------------------

### GET /status

Source: https://docs.pagos.ai/network-tokenization/testing

Retrieves the current status and details of a token using its tokenRefId.

```APIDOC
## GET /status

### Description
Retrieves the current status and details of a token using the tokenRefId returned during the tokenization process.

### Method
GET

### Response
#### Success Response (200)
- **tokenRefId** (string) - The unique identifier for the token.
- **expirationDate** (object) - The expiration details of the token.
- **status** (string) - The current status of the token (e.g., active).
- **cardNetworkName** (string) - The name of the card network.
- **panLast4** (string) - The last four digits of the PAN.

### Response Example
{
    "tokenRefId": "visa-8e9c3493ce9a2e299b7242b43254b625",
    "expirationDate": {
        "year": "2024",
        "month": "09"
    },
    "status": "active",
    "cardNetworkName": "visa",
    "panLast4": "1100"
}
```

--------------------------------

### GET /batch/files

Source: https://docs.pagos.ai/bin-data-APIs/endpoint/file-snapshot

Retrieves a list of files with their associated metadata and download URLs.

```APIDOC
## GET /batch/files

### Description
Retrieves a list of files available for download, including metadata about bin changes.

### Method
GET

### Endpoint
https://parrot.sandbox.pagosapi.com/batch/files

### Parameters
#### Headers
- **Authorization** (string) - Required - Format: `Bearer <api_key>`

### Response
#### Success Response (200)
- **type** (string) - File type
- **name** (string) - File name
- **url** (string) - Download URL
- **changes** (object) - Object containing bin update statistics

#### Response Example
[
  {
    "type": "<string>",
    "name": "<string>",
    "url": "<string>",
    "changes": {
      "bins_removed": 123,
      "bins_updated": 123,
      "bins_added": 123,
      "last_update_date": "<string>",
      "sources": [
        {
          "bins_total": 123,
          "source": "<string>",
          "changes": {
            "percentage": "<string>",
            "removed": 123,
            "updated": 123,
            "added": 123
          }
        }
      ]
    }
  }
]
```

--------------------------------

### Create Inquiry Job via Net::HTTP (Ruby)

Source: https://docs.pagos.ai/account-updater/endpoint/inquiries

Uses the built-in Ruby Net::HTTP library to execute the request.

```ruby
require 'uri'
require 'net/http'

url = URI("https://services.sandbox.pagosapi.com/loon/inquiries/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-merchant-id"] = '<x-merchant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'text/plain'
request.body = "{\n  \"content\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### GET /loon/inquiries/jobs/{jobId}

Source: https://docs.pagos.ai/account-updater/endpoint/status

Retrieves the status of an inquiry job by its unique identifier.

```APIDOC
## GET /loon/inquiries/jobs/{jobId}

### Description
Retrieves the status of a specific inquiry job. This endpoint provides details on the overall job status, potential errors, and the status of individual networks.

### Method
GET

### Endpoint
https://services.sandbox.pagosapi.com/loon/inquiries/jobs/{jobId}

### Parameters
#### Path Parameters
- **jobId** (integer) - Required - The unique identifier of the job.

#### Header Parameters
- **x-merchant-id** (string) - Required - Merchant identifier for requests.

### Response
#### Success Response (200)
- **status** (string) - The current status of the job.
- **error** (object) - Error details if the job failed.
- **networks** (array) - List of network statuses associated with the job.

#### Response Example
{
  "status": "completed",
  "networks": [
    {
      "network": "visa",
      "status": "success"
    }
  ]
}
```

--------------------------------

### Retrieve Batch BIN Files via cURL

Source: https://docs.pagos.ai/bin-data-APIs/batch-api-testing

Use this request to fetch an array of download URLs for mock BIN files in the sandbox environment. Ensure the Authorization header includes a valid API key.

```bash
curl --request GET \
  --url 'https://parrot.sandbox.pagosapi.com/batch/files' \
  --header 'Authorization:Bearer <api_key>'
```

--------------------------------

### GET /loon/inquiries/jobs/{jobId}/download

Source: https://docs.pagos.ai/account-updater/endpoint/download

Downloads the results for a specific job ID.

```APIDOC
## GET /loon/inquiries/jobs/{jobId}/download

### Description
Downloads the results associated with a specific job ID.

### Method
GET

### Endpoint
/loon/inquiries/jobs/{jobId}/download

### Parameters
#### Path Parameters
- **jobId** (integer) - Required - The unique identifier of the job.

#### Header Parameters
- **x-merchant-id** (string) - Required - Merchant identifier for requests.

### Response
#### Success Response (200)
- **Success** - The job results are returned in the response body.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden
```

--------------------------------

### Create a Dispute with cURL

Source: https://docs.pagos.ai/data-ingestion-api/endpoint/disputes

Executes a POST request using the command line interface.

```bash
curl --request POST \
  --url https://api.sandbox.nest.pagosapi.com/v1/{account_id}/disputes \
  --header 'Content-Type: application/json' \
  --data '
{
  "dispute_id": "<string>",
  "amount": 1,
  "currency": "<string>",
  "created": "<string>",
  "transaction_id": "<string>",
  "payment_method_details": {
    "payment_method_type": "<string>",
    "card": {
      "attributes": {
        "network": "<string>",
        "type": "<string>",
        "bin": "<string>",
        "issuer_bank": "<string>",
        "issuer_country": "<string>"
      }
    }
  },
  "pagos_codes": {},
  "amount_refunded": 1,
  "transaction_order_id": "<string>",
  "dispute_response": {
    "status": "<string>",
    "reason_code": "<string>",
    "reason": "<string>"
  },
  "additional_data": {
    "merchant_account_id": "<string>",
    "order_id": "<string>",
    "acquirer_reference_number": "<string>",
    "metadata": {}
  }
}
'
```
Tokens:
Raw