Create Payout

POST 
/payouts

Create Payout

Request

application/json

Body

required

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

object

required

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

metadata

object

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

Responses

201

Successful operation

application/json

Schema

Schema

id uuidrequired

The payout's id

source_id uuidrequired

The payout account's id used as the source account

sequence_number stringrequired

The reference number either created by you or generated by Moyasar

channel stringrequired

Possible values: [internal, ips, sarie]

The type of the channel which such payout is sent through

status stringrequired

Possible values: [queued, initiated, paid, failed, canceled, returned]

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
currency Currency (string)required

ISO-4217 three-letter currency code.

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]

comment stringrequired

The comment you provided when creating the payout

destination

object

required

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

message stringrequired

A human readable message to explain the status

failure_reason stringrequired

A classification of failure if any

created_at timestamprequired
updated_at timestamprequired

metadata

object

required

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

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
  "sequence_number": "6244377266243449",
  "channel": "internal",
  "status": "initiated",
  "amount": 100,
  "currency": "SAR",
  "purpose": "bills_or_rent",
  "comment": "my comment",
  "destination": {},
  "message": "Payment initiated",
  "failure_reason": "",
  "created_at": "Date and time when the payout was created.",
  "updated_at": "Date and time when the payout was last updated.",
  "metadata": {
    "cart_id": "72e470a5-cbc4-47b3-a52a-e89fda6adb19",
    "customer_email": "[email protected]",
    "customer_id": "23432"
  }
}

400

Business Error or validation error.

application/json

Schema

Schema

type string

Contains the error type

message string

Human readable error message for the error

errors object

Contains string-array pair representing a field and list of validation errors.

Example (from schema)

{
  "type": "invalid_request",
  "message": null,
  "errors": {
    "foo": "this is returned for validation errors only"
  }
}

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...