List Payment Orders

curl --request GET \
  --url https://api.vitawallet.io/api/businesses/payment_orders \
  --header 'Authorization: <api-key>' \
  --header 'x-date: <api-key>' \
  --header 'x-login: <api-key>' \
  --header 'x-trans-key: <api-key>'

import requests

url = "https://api.vitawallet.io/api/businesses/payment_orders"

headers = {
    "x-login": "<api-key>",
    "x-trans-key": "<api-key>",
    "x-date": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'x-login': '<api-key>',
    'x-trans-key': '<api-key>',
    'x-date': '<api-key>',
    Authorization: '<api-key>'
  }
};

fetch('https://api.vitawallet.io/api/businesses/payment_orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vitawallet.io/api/businesses/payment_orders",
  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: <api-key>",
    "x-date: <api-key>",
    "x-login: <api-key>",
    "x-trans-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vitawallet.io/api/businesses/payment_orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-login", "<api-key>")
	req.Header.Add("x-trans-key", "<api-key>")
	req.Header.Add("x-date", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.vitawallet.io/api/businesses/payment_orders")
  .header("x-login", "<api-key>")
  .header("x-trans-key", "<api-key>")
  .header("x-date", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vitawallet.io/api/businesses/payment_orders")

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

request = Net::HTTP::Get.new(url)
request["x-login"] = '<api-key>'
request["x-trans-key"] = '<api-key>'
request["x-date"] = '<api-key>'
request["Authorization"] = '<api-key>'

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

"{\r\n    \"payment_orders\": [\r\n        {\r\n            \"id\": \"174\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"bd20882d-455b-4eda-d2afa850c27f\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"ARS\",\r\n                    \"singular_name\": \"Peso argentino\",\r\n                    \"plural_name\": \"Pesos argentinos\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"AR\",\r\n                    \"name\": \"Argentina\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"ARS\",\r\n                        \"singular_name\": \"Peso argentino\",\r\n                        \"plural_name\": \"Pesos argentinos\"\r\n                    }\r\n                },\r\n                \"amount\": 10000,\r\n                \"url\": \"https://stage.vitawallet.io/s/uwN88Q\",\r\n                \"expires_at\": \"2026-10-05T14:22:06Z\",\r\n                \"created_at\": \"2026-10-05T13:22:06Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"172\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"f9711ccc-d87f-4bd1-2d012c9ac857\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 100,\r\n                \"url\": \"https://stage.vitawallet.io/s/OPz3Wk\",\r\n                \"expires_at\": \"2026-09-29T22:18:20Z\",\r\n                \"created_at\": \"2026-09-29T21:18:20Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"172\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"ba736fc9-5b9b-4434-8746-c4df1ba46e1e\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 100,\r\n                \"url\": \"https://stage.vitawallet.io/s/3JEP2l\",\r\n                \"expires_at\": \"2026-09-29T20:20:03Z\",\r\n                \"created_at\": \"2026-09-29T19:20:03Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"171\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"756d8a7c-e65a-4fa3-19bc27660a51\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 1000,\r\n                \"url\": \"https://stage.vitawallet.io/s/OjhsUE\",\r\n                \"expires_at\": \"2026-09-28T18:50:15Z\",\r\n                \"created_at\": \"2026-09-28T17:50:15Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"170\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"48f766e1-4e17-4a22-330293393598\",\r\n                \"issue\": \"Invoice\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": null,\r\n                \"cancel_redirect_url\": null,\r\n                \"error_redirect_url\": null,\r\n                \"pending_redirect_url\": null,\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"ARS\",\r\n                    \"singular_name\": \"Peso argentino\",\r\n                    \"plural_name\": \"Pesos argentinos\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"AR\",\r\n                    \"name\": \"Argentina\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"ARS\",\r\n                        \"singular_name\": \"Peso argentino\",\r\n                        \"plural_name\": \"Pesos argentinos\"\r\n                    }\r\n                },\r\n                \"amount\": 49659,\r\n                \"url\": \"https://stage.vitawallet.io/s/IirTcz\",\r\n                \"expires_at\": \"2026-09-28T16:26:00Z\",\r\n                \"created_at\": \"2026-09-28T15:26:00Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n    ],\r\n    \"total\": 5,\r\n    \"count\": 20,\r\n    \"applied_filters\": {\r\n        \"status\": null,\r\n        \"source_currency\": null,\r\n        \"target_currency\": null,\r\n        \"start_date\": \"2026-07-07\",\r\n        \"end_date\": \"2026-10-05\"\r\n    }\r\n}"

Direct Payment

List Payment Orders

This endpoint returns a paginated list of all payment orders in your business account, with support for filters by date range, status, source currency, and target currency. It’s the primary endpoint for monitoring, auditing, and reconciling the payment collection activity in your Payins integration.

Use it to build reporting dashboards, generate accounting exports, track the status of open payment links, or investigate specific transactions from your customer support flows.

Default Behavior

If no date range is specified, the endpoint automatically applies a default 90-day window:

start_date → today minus 90 days.
end_date → today.

You can override these defaults by explicitly providing the start_date and end_date query parameters (see below).

Recommended: For reconciliation and reporting flows, always specify explicit start_date and end_date values to guarantee predictable, repeatable queries.

Query Parameters

All parameters are optional. When omitted, the endpoint returns the last 90 days of payment orders in reverse chronological order.

Parameter	Type	Description
`start_date`	string (`YYYY-MM-DD`)	Start of the date range. Maximum: 2 years in the past. Cannot be a future date. Defaults to today minus 90 days.
`end_date`	string (`YYYY-MM-DD`)	End of the date range. Cannot be a future date. Defaults to today.
`status`	string	Filter by payment order status: `pending`, `paid`, `cancelled`, `expired`, `on_hold`, `reimbursed`, `reimbursing`.
`source_currency`	string (ISO)	Filter by source currency of the payment order (e.g., `USD`, `ARS`, `BOB`, `CLP`).
`target_currency`	string (ISO)	Filter by destination currency credited to your account (e.g., `COP`, `MXN`, `USD`).
`page`	integer	Page number to retrieve. Defaults to `1`.
`count`	integer	Number of results per page. Range: 1–100. Defaults to `20`.

Parameter Rules and Limits

Date Range Constraints

Maximum lookback: 2 years. Requests with a start_date older than 2 years will be rejected.
No future dates: Both start_date and end_date must be equal to or earlier than today.
Range order: start_date must be less than or equal to end_date.
Format: Dates must follow the YYYY-MM-DD format (e.g., 2026-01-15).

Pagination

Use page and count to navigate through large result sets.
The maximum allowed count is 100 per request. For larger exports, iterate through pages.
Combine filters (e.g., status + start_date + end_date) to reduce response size and improve query performance.

Request Examples

Basic — Default 90-day window

curl --location 'https://api.vitawallet.io/api/businesses/payment_orders'

Reconciliation — Paid orders in a specific month

curl --location 'https://api.vitawallet.io/api/businesses/payment_orders?status=paid&start_date=2026-01-01&end_date=2026-01-31&page=1&count=100'

Monitoring — Currently open (pending) orders

curl --location 'https://api.vitawallet.io/api/businesses/payment_orders?status=pending&count=50'

Filtered by currency pair — BOB collections credited in USD

curl --location 'https://api.vitawallet.io/api/businesses/payment_orders?source_currency=BOB&target_currency=USD&start_date=2026-08-01&end_date=2026-08-31'

Response Structure

The response returns a top-level payment_orders array. Each payment order is represented as an object with id, type, and an attributes object containing all its details.

Top-Level Fields

Field	Description
`payment_orders`	Array of payment order objects matching the applied filters.

Payment Order Object

Field	Description
`id`	Unique internal identifier of the payment order.
`type`	Resource type — always `"payment_order"`.
`attributes`	Object containing the payment order’s data (see below).

Payment Order Attributes

Field	Type	Description
`public_code`	string (UUID)	Public identifier of the payment order. Use this value to match webhook events (`payment_order.*`) and reconcile against your internal records.
`issue`	string	Free-text description or reference provided when the payment order was created.
`status`	string	Current status of the payment order: `pending`, `paid`, `cancelled`, `expired`, `on_hold`, `reimbursing`, `reimbursed`.
`success_redirect_url`	string	URL where the customer is redirected after a successful payment.
`cancel_redirect_url`	string	URL where the customer is redirected if they cancel the payment.
`error_redirect_url`	string	URL where the customer is redirected if an error occurs during payment.
`pending_redirect_url`	string	URL where the customer is redirected when the payment is left in a pending state.
`currency_destiny`	object	Destination currency object (the currency credited to your wallet). Includes `iso_code`, `singular_name`, and `plural_name`.
`source_currency`	object	Source currency object (the currency the customer pays in). Includes `iso_code`, `singular_name`, and `plural_name`.
`country`	object	Country object with `iso_code`, `name`, and a `default_currency` nested object.
`amount`	number	Amount of the payment order, expressed in the `source_currency`.
`url`	string	Public URL of the payment link to share with the customer.
`expires_at`	string (ISO 8601)	Expiration timestamp of the payment order.
`created_at`	string (ISO 8601)	Timestamp when the payment order was created.
`paid_at`	string (ISO 8601)	null
`paid_attempt`	object	null

Nested Objects

Currency object (currency_destiny, source_currency, country.default_currency):

Field	Description
`iso_code`	ISO currency code (e.g., `USD`, `BOB`, `COP`).
`singular_name`	Singular localized name of the currency (e.g., `"Boliviano"`).
`plural_name`	Plural localized name of the currency (e.g., `"Bolivianos"`).

Country object (country):

Field	Description
`iso_code`	ISO country code (e.g., `BO`, `CO`, `MX`).
`name`	Country name in Spanish (e.g., `"Bolivia"`).
`default_currency`	Default currency object for the country.

Response Example

{
  "payment_orders": [
    {
      "id": "311466",
      "type": "payment_order",
      "attributes": {
        "public_code": "88bf5de6-9dd8-43ee-af56-ec632a543b35",
        "issue": "This is a test",
        "status": "pending",
        "success_redirect_url": "https://www.google.com/success",
        "cancel_redirect_url": "https://www.google.com/cancel",
        "error_redirect_url": "https://www.google.com/error",
        "pending_redirect_url": "https://www.google.com/pending",
        "currency_destiny": {
          "iso_code": "USD",
          "singular_name": "Dólar Estadounidense",
          "plural_name": "Dólares Estadounidenses"
        },
        "source_currency": {
          "iso_code": "BOB",
          "singular_name": "Boliviano",
          "plural_name": "Bolivianos"
        },
        "country": {
          "iso_code": "BO",
          "name": "Bolivia",
          "default_currency": {
            "iso_code": "BOB",
            "singular_name": "Boliviano",
            "plural_name": "Bolivianos"
          }
        },
        "amount": 1158.05,
        "url": "https://app.vitawallet.io/s/nhZN0J",
        "expires_at": "2026-08-14T17:54:48Z",
        "created_at": "2026-08-14T14:54:48Z",
        "paid_at": null,
        "paid_attempt": null
      }
    }
  ]
}

Common Use Cases

Daily reconciliation: Retrieve all paid orders for the previous day to match against your internal accounting records.
Open orders monitoring: Fetch pending orders to display active payment links awaiting customer action.
Expired order cleanup: List expired orders to notify your customers or trigger recovery workflows.
Customer support lookups: Filter by date range and status when investigating specific issues reported by customers.
Multi-currency reporting: Combine source_currency and target_currency filters to analyze payment volume across different corridors.

Important Considerations

Default Date Window

If you don’t provide dates, only the last 90 days are returned. For historical queries beyond that, always specify start_date and end_date.

Match Orders with `public_code`

The public_code field is the identifier used across all webhook events. Always store it in your internal records to easily correlate webhook notifications with the corresponding payment order.

Combine Filters for Performance

Combining multiple filters (status + date range + currency) produces narrower, faster results. Broad queries on large accounts can be significantly slower.

Webhooks vs. Polling

For real-time updates on payment order status changes (e.g., payment_order.paid, payment_order.expired), use Webhooks. This endpoint is designed for reconciliation and historical queries, not as a substitute for event-driven notifications.

Pagination Discipline

Iterate through pages using page and count (max 100) until all results for your query are retrieved.

Reconciling with Payment Order Attempts

A single payment order can contain multiple attempts. When a payment order is paid, the paid_attempt field provides details about the successful attempt. Use public_code to correlate with any payment_order_attempt.* webhook events you may have received.

Source vs. Destination Currency

source_currency is the currency the customer paid in.
currency_destiny is the currency credited to your business wallet after conversion.
The amount field is expressed in the source_currency.

Quick Recap

Call GET /api/businesses/payment_orders with the filters that match your use case.
If no filters are provided, the endpoint returns the last 90 days of orders.
Combine start_date, end_date, status, and currency filters to narrow the results.
Paginate using page and count (maximum 100 per page).
Store the public_code returned in your internal records to match webhook events and reconcile orders end-to-end.

GET

api

businesses

payment_orders

List Payment Orders

curl --request GET \
  --url https://api.vitawallet.io/api/businesses/payment_orders \
  --header 'Authorization: <api-key>' \
  --header 'x-date: <api-key>' \
  --header 'x-login: <api-key>' \
  --header 'x-trans-key: <api-key>'

import requests

url = "https://api.vitawallet.io/api/businesses/payment_orders"

headers = {
    "x-login": "<api-key>",
    "x-trans-key": "<api-key>",
    "x-date": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'x-login': '<api-key>',
    'x-trans-key': '<api-key>',
    'x-date': '<api-key>',
    Authorization: '<api-key>'
  }
};

fetch('https://api.vitawallet.io/api/businesses/payment_orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vitawallet.io/api/businesses/payment_orders",
  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: <api-key>",
    "x-date: <api-key>",
    "x-login: <api-key>",
    "x-trans-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.vitawallet.io/api/businesses/payment_orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-login", "<api-key>")
	req.Header.Add("x-trans-key", "<api-key>")
	req.Header.Add("x-date", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.vitawallet.io/api/businesses/payment_orders")
  .header("x-login", "<api-key>")
  .header("x-trans-key", "<api-key>")
  .header("x-date", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vitawallet.io/api/businesses/payment_orders")

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

request = Net::HTTP::Get.new(url)
request["x-login"] = '<api-key>'
request["x-trans-key"] = '<api-key>'
request["x-date"] = '<api-key>'
request["Authorization"] = '<api-key>'

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

"{\r\n    \"payment_orders\": [\r\n        {\r\n            \"id\": \"174\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"bd20882d-455b-4eda-d2afa850c27f\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"ARS\",\r\n                    \"singular_name\": \"Peso argentino\",\r\n                    \"plural_name\": \"Pesos argentinos\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"AR\",\r\n                    \"name\": \"Argentina\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"ARS\",\r\n                        \"singular_name\": \"Peso argentino\",\r\n                        \"plural_name\": \"Pesos argentinos\"\r\n                    }\r\n                },\r\n                \"amount\": 10000,\r\n                \"url\": \"https://stage.vitawallet.io/s/uwN88Q\",\r\n                \"expires_at\": \"2026-10-05T14:22:06Z\",\r\n                \"created_at\": \"2026-10-05T13:22:06Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"172\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"f9711ccc-d87f-4bd1-2d012c9ac857\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 100,\r\n                \"url\": \"https://stage.vitawallet.io/s/OPz3Wk\",\r\n                \"expires_at\": \"2026-09-29T22:18:20Z\",\r\n                \"created_at\": \"2026-09-29T21:18:20Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"172\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"ba736fc9-5b9b-4434-8746-c4df1ba46e1e\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 100,\r\n                \"url\": \"https://stage.vitawallet.io/s/3JEP2l\",\r\n                \"expires_at\": \"2026-09-29T20:20:03Z\",\r\n                \"created_at\": \"2026-09-29T19:20:03Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"171\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"756d8a7c-e65a-4fa3-19bc27660a51\",\r\n                \"issue\": \"This is a test\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": \"https://www.google.com/success\",\r\n                \"cancel_redirect_url\": \"https://www.google.com/cancel\",\r\n                \"error_redirect_url\": \"https://www.google.com/error\",\r\n                \"pending_redirect_url\": \"https://www.google.com/pending\",\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"BRL\",\r\n                    \"singular_name\": \"Real brasileño\",\r\n                    \"plural_name\": \"Reales brasileños\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"BR\",\r\n                    \"name\": \"Brasil\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"BRL\",\r\n                        \"singular_name\": \"Real brasileño\",\r\n                        \"plural_name\": \"Reales brasileños\"\r\n                    }\r\n                },\r\n                \"amount\": 1000,\r\n                \"url\": \"https://stage.vitawallet.io/s/OjhsUE\",\r\n                \"expires_at\": \"2026-09-28T18:50:15Z\",\r\n                \"created_at\": \"2026-09-28T17:50:15Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n        {\r\n            \"id\": \"170\",\r\n            \"type\": \"payment_order\",\r\n            \"attributes\": {\r\n                \"public_code\": \"48f766e1-4e17-4a22-330293393598\",\r\n                \"issue\": \"Invoice\",\r\n                \"status\": \"pending\",\r\n                \"success_redirect_url\": null,\r\n                \"cancel_redirect_url\": null,\r\n                \"error_redirect_url\": null,\r\n                \"pending_redirect_url\": null,\r\n                \"currency_destiny\": {\r\n                    \"iso_code\": \"USD\",\r\n                    \"singular_name\": \"Dólar estadounidense\",\r\n                    \"plural_name\": \"Dólares estadounidenses\"\r\n                },\r\n                \"source_currency\": {\r\n                    \"iso_code\": \"ARS\",\r\n                    \"singular_name\": \"Peso argentino\",\r\n                    \"plural_name\": \"Pesos argentinos\"\r\n                },\r\n                \"country\": {\r\n                    \"iso_code\": \"AR\",\r\n                    \"name\": \"Argentina\",\r\n                    \"default_currency\": {\r\n                        \"iso_code\": \"ARS\",\r\n                        \"singular_name\": \"Peso argentino\",\r\n                        \"plural_name\": \"Pesos argentinos\"\r\n                    }\r\n                },\r\n                \"amount\": 49659,\r\n                \"url\": \"https://stage.vitawallet.io/s/IirTcz\",\r\n                \"expires_at\": \"2026-09-28T16:26:00Z\",\r\n                \"created_at\": \"2026-09-28T15:26:00Z\",\r\n                \"paid_at\": null,\r\n                \"paid_attempt\": null\r\n            }\r\n        },\r\n    ],\r\n    \"total\": 5,\r\n    \"count\": 20,\r\n    \"applied_filters\": {\r\n        \"status\": null,\r\n        \"source_currency\": null,\r\n        \"target_currency\": null,\r\n        \"start_date\": \"2026-07-07\",\r\n        \"end_date\": \"2026-10-05\"\r\n    }\r\n}"

Authorizations

Business xLogin

x-trans-key

string

header

required

Business xTransKey

x-date

string

header

required

ISO8601 datetime

Authorization

string

header

required

V2-HMAC-SHA256 signature. Example: V2-HMAC-SHA256, Signature: <hash>

Response

200 - application/json

Successful response.

Payins

Exchange

Payouts

Transactions

Users

Webhooks

List Payment Orders

Default Behavior

Query Parameters

Parameter Rules and Limits

Date Range Constraints

Pagination

Request Examples

Basic — Default 90-day window

Reconciliation — Paid orders in a specific month

Monitoring — Currently open (pending) orders

Filtered by currency pair — BOB collections credited in USD

Response Structure

Top-Level Fields

Payment Order Object

Payment Order Attributes

Nested Objects

Response Example

Common Use Cases

Important Considerations

Default Date Window

Match Orders with `public_code`

Combine Filters for Performance

Webhooks vs. Polling

Pagination Discipline

Reconciling with Payment Order Attempts

Source vs. Destination Currency

Quick Recap

Authorizations

Response