Skip to main content
PUT
Save your payout method

Authorizations

Authorization
string
header
required

Authorization: Bearer

Body

application/json
account_holder_name
string
required

2 to 70 characters, letters first. Names in any script, including Arabic. For cash, the full name of the person who will collect the money, as on their ID card.

Example:

"Al Noor Shop"

method
enum<string>

Optional. bank (the default when left out) or cash. cash is accepted only when Mart offers it to your account (403 cash_not_allowed), and bank only when Mart offers a bank transfer to your account (422 bank_transfer_not_allowed). You cannot switch between the two while a withdrawal is open (409 payout_method_change_blocked).

Available options:
bank,
cash
Example:

"bank"

iban
string

Required for a bank transfer, ignored for cash. Spaces and case are ignored. Up to 34 characters once cleaned.

Example:

"PS92PALS000000000400123456702"

national_id
string | null

Optional. 5 to 32 letters, digits or hyphens. Arabic digits are accepted and stored as 0 to 9. Omitted keeps the saved one, except on a switch between bank and cash, which clears it; null or an empty string clears it. For cash, the collector's ID number: send it on the switch.

Example:

"123456789"

Response

Saved. The same object GET returns. Also 200 when nothing changed.

status
enum<string>
required
Available options:
success
status_code
integer
required
Example:

200

message
string
required
Example:

"OK"

data
object
required

One key named after the resource (products / product / states / categories / attributes / order / validation).

meta
object | null
required
error
object | null
required