Create a payment intent

POST {{baseUrl}}/v1/paymentIntents

Create a transient or continuous payment intent

Body Params

Option 1

idempotencyKey string (REQUIRED) Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

amount object (REQUIRED)

  • amount string (REQUIRED) Magnitude of the amount, in units of the currency, with a ..

  • currency string (REQUIRED) Currency code.

settlementCurrency string (REQUIRED) Desired currency for the payments to settle in.

paymentMethods array (REQUIRED)

merchantWalletId string Unique system generated identifier for the wallet of the merchant.

Option 2

idempotencyKey string (REQUIRED) Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

currency string (REQUIRED) Desired currency for the payment

settlementCurrency string (REQUIRED) Desired currency for the payments to settle in.

paymentMethods array (REQUIRED)

merchantWalletId string Unique system generated identifier for the wallet of the merchant.

type string

Request Body

{"idempotencyKey"=>"{{$guid}}", "amount"=>{"amount"=>"3.14", "currency"=>"BTC"}, "settlementCurrency"=>"BTC", "paymentMethods"=>[{"type"=>"blockchain", "chain"=>"NOBLE", "address"=>"0x8381470ED67C3802402dbbFa0058E8871F017A6F"}, {"type"=>"blockchain", "chain"=>"BASE", "address"=>"0x8381470ED67C3802402dbbFa0058E8871F017A6F"}], "merchantWalletId"=>"212000"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"data":{"id":"5e1d524b-79f7-420e-8437-c17c84a79c34","amountPaid":{"amount":"0.00","currency":"USD"},"amountRefunded":{"amount":"0.00","currency":"USD"},"settlementCurrency":"USD","paymentMethods":[{"type":"blockchain","chain":"ETH","address":"0x35cEd7A9A8d31D68Ad149049cCDa3a6D832a2EF8"}],"timeline":[{"status":"created","time":"2024-01-17T17:59:03.247814Z"}],"createDate":"2024-01-17T17:59:03.245Z","updateDate":"2024-01-17T17:59:03.245Z","merchantWalletId":"1000594146","amount":{"amount":"3.14","currency":"USD"},"paymentIds":[],"refundIds":[]}}