Fetch Payout Account

GET 
/payout_accounts/:id

Retrieve a single Moyasar payout account by its ID to view its type, status, and balance.

Request

Path Parameters

id uuidrequired

ID of the payout account to fetch

Responses

200

Successful operation

application/json

Schema

Schema

id uuidrequired

The ID of the payout account.

account_type AccountType (string)required

Possible values: [bank, wallet]

Indicates the payout account type.

currency Currency (string)required

ISO-4217 three-letter currency code.

properties objectrequired

Contains the public information relevant to the payout account. For example, the IBAN of the bank account. Every service provider can provide a different set of properties.

created_at timestamprequired

Date and time when the payout account was created.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account_type": "bank",
  "currency": "SAR",
  "properties": {
    "iban": "SA8430400108057386290038"
  },
  "created_at": "Date and time when the payout account was created."
}

401

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [authentication_error]

message string

Possible values: [Invalid authorization credentials]

errors object

Example (from schema)

{
  "type": "authentication_error",
  "message": "Invalid authorization credentials",
  "errors": null
}

403

Invalid authorization credentials

application/json

Schema

Schema

type string

Possible values: [api_error]

message string

Possible values: [User not authorized]

errors object

Example (from schema)

{
  "type": "api_error",
  "message": "User not authorized",
  "errors": null
}

404

One of the record referenced in the request was not found

application/json

Schema

Schema

type string

Possible values: [record_not_found]

message string
errors object

Example (from schema)

{
  "type": "record_not_found",
  "message": "The <object type> record you were looking for was not found.",
  "errors": null
}

Loading...