Skip to main content
PUT

Authorizations

Authorization
string
header
required

Your secret key as a Bearer token. The key prefix selects the environment: sk_test_... (test) or sk_live_... (live).

Path Parameters

paymentToken
string
required

The escrow's payment token (e.g. PY_8AB12C9D3045).

Body

application/json
additionalFee
integer
required

The charge to add on top of the escrow amount, as a whole number in NGN. Send 0 to remove a charge set earlier.

Required range: x >= 0
Example:

2500

additionalFeeRefundable
boolean
default:true

The default for who keeps the charge if a dispute is resolved in the buyer's favour: true returns it to the buyer, false credits it to you. Usually left alone, since the decision is normally made when resolving the dispute, which overrides this. Omit to leave the escrow's current setting unchanged.

Example:

true

Response

Additional fee updated.

status
integer
Example:

200

message
string
Example:

"Operation successful"

data
object