Skip to main content
POST
Create FX operation

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"

declaredBeneficiaryName
string
Example:

"Shenzhen NovaTech Components Co Ltd"

declaredEconomicOwnerName
string
Example:

"Shenzhen NovaTech Components Co Ltd"

buyerCountry
string
Pattern: ^[A-Z]{2}$
Example:

"BR"

Response

Operation created.

operationId
string
Example:

"op_example"

partnerOperationId
string
Example:

"acme-op-123"

status
string
Example:

"REQUIREMENTS_PENDING"

requirementsStatus
string
Example:

"PENDING"