Get operation status

curl --request GET \
  --url https://sandbox.payfi.global/v1/operations/{operationId} \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>'

import requests

url = "https://sandbox.payfi.global/v1/operations/{operationId}"

headers = {
    "X-PayFi-Api-Key": "<api-key>",
    "X-PayFi-Nonce": "<api-key>",
    "X-PayFi-Signature": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-PayFi-Api-Key': '<api-key>',
    'X-PayFi-Nonce': '<api-key>',
    'X-PayFi-Signature': '<api-key>'
  }
};

fetch('https://sandbox.payfi.global/v1/operations/{operationId}', 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://sandbox.payfi.global/v1/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-PayFi-Api-Key: <api-key>",
    "X-PayFi-Nonce: <api-key>",
    "X-PayFi-Signature: <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://sandbox.payfi.global/v1/operations/{operationId}"

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

	req.Header.Add("X-PayFi-Api-Key", "<api-key>")
	req.Header.Add("X-PayFi-Nonce", "<api-key>")
	req.Header.Add("X-PayFi-Signature", "<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://sandbox.payfi.global/v1/operations/{operationId}")
  .header("X-PayFi-Api-Key", "<api-key>")
  .header("X-PayFi-Nonce", "<api-key>")
  .header("X-PayFi-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.payfi.global/v1/operations/{operationId}")

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

request = Net::HTTP::Get.new(url)
request["X-PayFi-Api-Key"] = '<api-key>'
request["X-PayFi-Nonce"] = '<api-key>'
request["X-PayFi-Signature"] = '<api-key>'

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

{
  "operationId": "op_example_pending",
  "partnerOperationId": "acme-op-123",
  "customerId": "cus_example",
  "status": "REQUIREMENTS_PENDING",
  "operationType": "IMPORT_GOODS",
  "exchangeModality": "TERM",
  "requirementsStatus": "PENDING",
  "requiredDocumentTypes": [],
  "missingDocumentTypes": [],
  "score0To100": null,
  "score1To10": null,
  "riskLevel": null,
  "createdAt": "2026-05-20T12:00:00.000Z",
  "updatedAt": "2026-05-20T12:00:00.000Z"
}

GET

operations

{operationId}

Get operation status

curl --request GET \
  --url https://sandbox.payfi.global/v1/operations/{operationId} \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>'

import requests

url = "https://sandbox.payfi.global/v1/operations/{operationId}"

headers = {
    "X-PayFi-Api-Key": "<api-key>",
    "X-PayFi-Nonce": "<api-key>",
    "X-PayFi-Signature": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-PayFi-Api-Key': '<api-key>',
    'X-PayFi-Nonce': '<api-key>',
    'X-PayFi-Signature': '<api-key>'
  }
};

fetch('https://sandbox.payfi.global/v1/operations/{operationId}', 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://sandbox.payfi.global/v1/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-PayFi-Api-Key: <api-key>",
    "X-PayFi-Nonce: <api-key>",
    "X-PayFi-Signature: <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://sandbox.payfi.global/v1/operations/{operationId}"

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

	req.Header.Add("X-PayFi-Api-Key", "<api-key>")
	req.Header.Add("X-PayFi-Nonce", "<api-key>")
	req.Header.Add("X-PayFi-Signature", "<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://sandbox.payfi.global/v1/operations/{operationId}")
  .header("X-PayFi-Api-Key", "<api-key>")
  .header("X-PayFi-Nonce", "<api-key>")
  .header("X-PayFi-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.payfi.global/v1/operations/{operationId}")

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

request = Net::HTTP::Get.new(url)
request["X-PayFi-Api-Key"] = '<api-key>'
request["X-PayFi-Nonce"] = '<api-key>'
request["X-PayFi-Signature"] = '<api-key>'

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

{
  "operationId": "op_example_pending",
  "partnerOperationId": "acme-op-123",
  "customerId": "cus_example",
  "status": "REQUIREMENTS_PENDING",
  "operationType": "IMPORT_GOODS",
  "exchangeModality": "TERM",
  "requirementsStatus": "PENDING",
  "requiredDocumentTypes": [],
  "missingDocumentTypes": [],
  "score0To100": null,
  "score1To10": null,
  "riskLevel": null,
  "createdAt": "2026-05-20T12:00:00.000Z",
  "updatedAt": "2026-05-20T12:00:00.000Z"
}

Authorizations

X-PayFi-Api-Key

string

header

required

X-PayFi-Nonce

string

header

required

X-PayFi-Signature

string

header

required

Path Parameters

operationId

string

required

Operation ID.

Response

Operation status.

operationId

string

Example:

"op_example"

partnerOperationId

string | null

Example:

"acme-op-123"

customerId

string | null

Example:

"cus_example"

status

enum<string>

Available options:

CREATED,

REQUIREMENTS_PENDING,

REQUIREMENTS_REVIEW_REQUIRED,

REQUIREMENTS_FAILED,

AWAITING_DOCUMENTS,

DOCUMENTS_PARTIAL,

DOCUMENTS_UPLOADED,

PROCESSING,

PROCESSING_FAILED,

ACTION_REQUIRED,

READY_FOR_MANUAL_REVIEW,

MANUAL_REVIEW_APPROVED,

MANUAL_REVIEW_REJECTED,

MANUAL_REVIEW_CHANGES_REQUESTED,

PARTNER_CALLBACK_PENDING,

PARTNER_CALLBACK_DELIVERED,

PARTNER_CALLBACK_FAILED,

CANCELLED,

FAILED

Example:

"REQUIREMENTS_REVIEW_REQUIRED"

operationType

enum<string>

Available options:

IMPORT_GOODS,

EXPORT_GOODS,

SERVICES

Example:

"IMPORT_GOODS"

exchangeModality

enum<string>

Available options:

ADVANCE,

SIGHT,

TERM

Example:

"TERM"

requirementsStatus

enum<string>

Available options:

PENDING,

REVIEW_REQUIRED,

APPROVED,

FAILED

Example:

"REVIEW_REQUIRED"

requiredDocumentTypes

enum<string>[]

Available options:

invoice,

bill_of_lading,

packing_list,

di_duimp,

bank_details,

proforma,

service_contract,

insurance_policy

Example:

["invoice", "bill_of_lading", "packing_list"]

missingDocumentTypes

enum<string>[]

Available options:

invoice,

bill_of_lading,

packing_list,

di_duimp,

bank_details,

proforma,

service_contract,

insurance_policy

Example:

["invoice"]

score0To100

number | null

Example:

null

score1To10

number | null

Example:

null

riskLevel

enum<string> | null

Available options:

low,

medium,

high,

critical,

unknown

Example:

null

declaredBeneficiaryName

string | null

Example:

"Shenzhen NovaTech Components Co Ltd"

declaredEconomicOwnerName

string | null

Example:

"Shenzhen NovaTech Components Co Ltd"

buyerCountry

string | null

Example:

"BR"

createdAt

string

Example:

"2026-05-20T12:00:00.000Z"

updatedAt

string

Example:

"2026-05-20T12:00:00.000Z"

Create FX operation Get operation status

Customers

Operations

Webhooks

Get operation status

Authorizations

Path Parameters

Response