Skip to main content
POST

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).

Headers

customer-id
string
required

The merchant customer this request acts on behalf of.

Body

application/json
amount
number
required

Total amount to charge the buyer. Must equal the escrow amount plus the buyer's fee share, otherwise the request is rejected with "Amount mismatch".

Required range: x >= 1000
Example:

10503.75

reference
string
required

Your unique reference for this payment.

Example:

"ESC_REF_98765"

transactionType
enum<string>
default:escrow
required
Available options:
escrow
Example:

"escrow"

escrowDetails
object
required
gateway
enum<string>
default:card

Funding source. 'wallet' debits the buyer's Payluk wallet, 'card' charges a debit card.

Available options:
card,
wallet
Example:

"wallet"

cardId
string

Saved card identifier. Only used when gateway is 'card' and paying with an existing saved card.

currency
string
default:NGN

Optional. Defaults to NGN.

Response

Escrow funded.