Skip to main content
POST
Resolve Payment Method Requirements
We recommend using the sessionId returned by the v2 rates endpoint throughout payment-method discovery, requirement resolution, quoting, and execution. It is optional; when omitted, send the original asset, currency, amount, amount side, and provider routing fields instead. When the requirements response includes a top-level resolution contract, submit the form values using its method, url, body, and inputPath rather than reconstructing provider-routing fields in the client. The response preserves the session ID and expiry. If the session expires or its provider route becomes unavailable, request a new rate and restart the flow.
For customer identity, session binding, onboarding recovery and fee semantics, see Customer fiat flows.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Wallet identifier.

Body

application/json

Supply sessionId, or all original routing fields. Repeated fields must match the session. Customer identity is inherited from the session.

sessionId
string<uuid>
required

Session ID returned by the v2 rates endpoint.

paymentMethod
string
required

Payment-method id.

Example:

"bank_transfer"

paymentMethodData
object
required

Current form values required by the x-resolution request.

Example:
customerId
string<uuid>

ID of an existing active customer owned by the authenticated business.

assetId
string<uuid>
deprecated

Stablecoin asset identifier.

Example:

"ae455f23-3824-4125-baab-d158315cbcbd"

currency
string
deprecated

ISO 4217 payout currency.

Required string length: 3
Example:

"NGN"

amount
string
deprecated

Withdrawal amount as a decimal string.

Pattern: ^\d+(\.\d+)?$
Example:

"100.00"

provider
string
deprecated

Provider slug selected earlier in the flow.

Example:

"example-provider"

amountSide
enum<string>
default:source

source fixes the total source-asset budget, with fees allocated inside it; target fixes the fiat payout before beneficiary deductions and derives the required source debit.

Available options:
source,
target
continuation
object

Submit only after requires_action. Keep the original paymentMethodData unchanged.

Response

Successful response.

message
string
required

Human-readable result.

Example:

"Payment method resolved successfully"

data
object
required
status
boolean
required
Example:

true