Skip to main content
GET
Retrieve payment instructions

Authorizations

Authorization
string
header
required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

X-Organization-Id
string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Pattern: ^org_[A-Za-z0-9]+$
Example:

"org_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Path Parameters

id
string
required

ID of the payment instructions

Pattern: ^pmi_[A-Za-z0-9]+$
Example:

"pmi_021wlGURMlk80cYuKBjENXqwC3OV"

Response

Payment instructions details

object
enum<string>
required

Object type identifier.

Available options:
payment_instructions
Example:

"payment_instructions"

livemode
boolean
required

Whether this object exists in live mode (true) or test mode (false).

id
string
required

ID of the payment instructions

Pattern: ^pmi_[A-Za-z0-9]+$
Example:

"pmi_021wlGURMlk80cYuKBjENXqwC3OV"

entity
string
required

ID of the entity these instructions belong to.

Pattern: ^ent_[A-Za-z0-9]+$
Example:

"ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p"

external_reference
string | null
required

Your own identifier for this payment instructions

Example:

"payment-instructions-123"

beneficiary_name
string
required

Name of the account holder, as registered with the bank.

Example:

"Jane Doe"

created_at
string<date-time>
required
updated_at
string<date-time>
required
ach
object
wire
object