Skip to main content
GET
/
v1
/
operations
List FX operations
curl --request GET \
  --url https://sandbox.payfi.global/v1/operations \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>'
{
  "data": [
    {
      "operationId": "op_example",
      "partnerOperationId": "acme-op-123",
      "customerId": "cus_example",
      "status": "REQUIREMENTS_REVIEW_REQUIRED",
      "operationType": "IMPORT_GOODS",
      "exchangeModality": "TERM",
      "requirementsStatus": "REVIEW_REQUIRED",
      "requiredDocumentTypes": [],
      "missingDocumentTypes": [],
      "score0To100": null,
      "riskLevel": null,
      "createdAt": "2026-05-20T12:00:00.000Z",
      "updatedAt": "2026-05-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.payfi.global/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-PayFi-Api-Key
string
header
required
​
X-PayFi-Nonce
string
header
required
​
X-PayFi-Signature
string
header
required

Query Parameters

​
operationId
string

Exact PayFi operation ID filter.

Example:

"op_example"

​
partnerOperationId
string

Exact partner operation ID filter.

Example:

"acme-op-123"

​
customerId
string

Exact PayFi customer ID filter.

Example:

"cus_example"

​
search
string

Searches operation IDs, partner operation IDs, customer IDs, customer legal names, partner customer IDs, status fields, and operation type aliases such as Importação.

Example:

"Acme"

​
page
integer

Page number starting at 1.

Required range: x >= 1
Example:

1

​
limit
integer

Items per page. Maximum 100.

Required range: 1 <= x <= 100
Example:

20

Response

Paginated operations.

​
data
object[]
required
Example:
[]
​
pagination
object
required