Skip to main content
POST
/
v1
/
operations
Create FX operation
curl --request POST \
  --url https://sandbox.payfi.global/v1/operations \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <api-key>' \
  --header 'X-PayFi-Api-Key: <api-key>' \
  --header 'X-PayFi-Nonce: <api-key>' \
  --header 'X-PayFi-Signature: <api-key>' \
  --data '
{
  "customerId": "cus_example",
  "operationType": "IMPORT_GOODS",
  "exchangeModality": "TERM",
  "partnerOperationId": "acme-op-123"
}
'
{
  "operationId": "op_example",
  "partnerOperationId": "acme-op-123",
  "status": "REQUIREMENTS_PENDING",
  "requirementsStatus": "PENDING"
}

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
​
Idempotency-Key
string
header
required

Body

application/json

Operation payload.

​
customerId
string
required
Example:

"cus_example"

​
operationType
enum<string>
required
Available options:
IMPORT_GOODS,
EXPORT_GOODS,
SERVICES
Example:

"IMPORT_GOODS"

​
exchangeModality
enum<string>
required
Available options:
ADVANCE,
SIGHT,
TERM
Example:

"TERM"

​
partnerOperationId
string
Example:

"acme-op-123"

Response

Operation created.

​
operationId
string
Example:

"op_example"

​
partnerOperationId
string
Example:

"acme-op-123"

​
status
string
Example:

"REQUIREMENTS_PENDING"

​
requirementsStatus
string
Example:

"PENDING"