Skip to main content
POST
curl

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

user_id
string
required

ID of the user the new account belongs to. For partners operating in the B2B2C model, this is the Sub-User the request is acting on behalf of.

Required string length: 14 - 42

Body

application/json
name
string
required

Human-friendly name for the account. Payward stores this verbatim and does not interpret it. Names are not required to be unique for a user.

Required string length: 4 - 64
Example:

"Savings"

description
string

Optional description for the account.

Required string length: 1 - 128
Example:

"Long-term savings balance"

Response

Created

data
object
required

Created account payload.