List Payouts

GET 
/payouts

List Payouts

Request

Query Parameters

page int32

Default value: 1

Page to list

Responses

200

Successful operation

application/json

Schema

Schema

payoutsobject[]required

Array [

source_id uuidrequired

The payout account's id to be used as the source account

sequence_number string

A 16 digits string reference for the payout. If omitted, Moyasar will generate one for you

amount integerrequired

A positive integer representing the payout amount in the smallest currency unit.

Examples:

• 1.00 SAR = 100
• 1.00 KWD = 1000
• 1 JPY = 1

purpose stringrequired

Possible values: [bills_or_rent, expenses_services, purchase_assets, saving_investment, government_dues, money_exchange, credit_card_loan, gift_or_reward, personal, investment_transaction, family_assistance, donation, payroll_benefits, online_purchase, hajj_and_umra, dividend_payment, government_payment, investment_house, payment_to_merchant, own_account_transfer]

destination

objectrequired

Contains the beneficiary's information.

oneOf

BankDestination

type stringrequired

Should always be "bank"

iban stringrequired

The IBAN of the beneficiary

name stringrequired

the beneficiary's name

mobile stringrequired

the beneficiary's mobile

country stringrequired

the beneficiary's country

city stringrequired

the beneficiary's city

WalletDestination

type stringrequired

Should always be "wallet"

mobile stringrequired

the beneficiary's mobile

comment string

The comment you provided when creating the payout

metadataobject

A set of key-value pairs where both key and value are strings. Metadata allows you to add more information to the object that will be returned later on in responses and webhook messages. Metadata is searchable using the Payment List API.

property name* string

]

metaobjectrequired
current_page integer
next_page integer
prev_page integer
total_pages integer
total_count integer

Example (from schema)

{
  "payouts": [
    {
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "sequence_number": "6244377266243449",
      "amount": 100,
      "purpose": "bills_or_rent",
      "destination": {},
      "comment": "my comment",
      "metadata": {
        "cart_id": "72e470a5-cbc4-47b3-a52a-e89fda6adb19",
        "customer_email": "[email protected]",
        "customer_id": "23432"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

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
}

Loading...