Skip to main content
POST
/
v1
/
customers
Upsert customer
curl --request POST \
  --url https://sandbox.payfi.global/v1/customers \
  --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 '
{
  "partnerCustomerId": "acme-customer-123",
  "legalName": "Acme Ltda",
  "taxId": "12.345.678/0001-95"
}
'
{
  "customerId": "cus_example",
  "partnerCustomerId": "acme-customer-123",
  "legalName": "Acme Ltda"
}

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

Customer payload.

​
partnerCustomerId
string
required
Example:

"acme-customer-123"

​
legalName
string
required
Example:

"Acme Ltda"

​
taxId
string
required
Example:

"12.345.678/0001-95"

​
metadata
object

Response

Customer upserted.

​
customerId
string
Example:

"cus_example"

​
partnerCustomerId
string
Example:

"acme-customer-123"

​
legalName
string
Example:

"Acme Ltda"