Create a payment

post

https://sandbox.notabene.id/api/v1/payments

Creates a TAIP-14 payment request from a merchant to a payer. When the payer's institution is not yet known, omit customer_entity and share the returned payment_link instead.

Required permission: create:transfer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

string

required

The amount paid, in the asset's whole units rather than its smallest unit. For example 1.5 ETH, not 1500000000000000000.

asset

string

The asset being paid, as a CAIP-19 identifier or a plain symbol such as BTC. Symbols resolve to their canonical CAIP-19 identifier.

currency

string

ISO 4217 currency to denominate the payment in, as an alternative to asset.

customer

object

The party making the payment.

customer_entity

string

DID of the payer's institution. Omit to create a payment link instead.

customer_id

string

IRI of an existing customer to use as the payer, instead of supplying customer inline.

expiry

string

When the payment link stops being usable, as an RFC 3339 timestamp.

fallback_settlement_addresses

array of strings | null

Additional addresses the payer may settle to when the primary one cannot be used.

fallback_settlement_addresses

memo

string

Free-text memo shown to the payer.

merchant

object

The party receiving the payment.

merchant_id

string

IRI of an existing customer to use as the merchant, instead of supplying merchant inline.

ref

string

Your own unique reference for this payment (UUID). Reusing it makes creation idempotent.

supported_assets

array of strings | null

The assets you accept for this payment, as CAIP-19 identifiers or plain symbols. Symbols resolve to their canonical CAIP-19 identifier.

supported_assets

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Created

400Bad Request. A missing or invalid field or parameter is listed under errors, with the field when it can be named. Any other reason comes as a problem document, with the reason in detail.

401Unauthorized: the access token is missing, malformed or expired. Request a new one, as Authentication explains.

403Forbidden: the token cannot make this call. It lacks the permission named above.

defaultAny other error, as a problem document.