Skip to main content
PATCH
Update payment account

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

id
string<uuid>
required

The payment account id.

Body

application/json
label
string
required

The new label.

Response

The updated payment account.

id
string<uuid>
required
status
enum<string>
required

The account as a whole. ready when any rail direction is ready. rejected when every rail direction is rejected; register the account again with corrected registrationInfo to retry. disabled when we turned the account off; it cannot be registered or quoted. Otherwise pending. Readiness per rail and direction is in rails.

Available options:
pending,
ready,
rejected,
disabled
label
string
required

Your organization's name for the account.

rails
object
required

The rails this account can move money on, keyed by rail name (a PaymentRail value such as spei or stellar). A rail the account cannot move money on is absent. The account identifier you registered is not returned.

createdAt
string<date-time>
required