Create partner card

Issues a virtual partner card to one of your business's users, with a spending limit you set. Use it to give a partner or supplier a card for a single booking or a fixed budget.

Send the card holder's email and the card's amount limit. The user must already exist on your business and have a verified phone number. The amount must be less than the larger of your Payments available balance and your Debit card account balance. If your Debit card account balance covers it, the amount moves from the Debit card account to the card; otherwise it's taken from your Payments balance (in AED).

Optional fields:

  • transactions_limit: how many transactions the card allows. If you omit it, the card allows 1 transaction.
  • card_name: a label for the card. Defaults to Partner card.
  • booking_id: your own reference, returned on the card.
  • verification_email: if set, opening the card's url requires a one-time code sent to this address. It is not returned.

The name printed on the card (card_holder_name) is always your business's operating name, cut to 30 characters.

The response is the new card, including its id and a url the card holder can open to see the card details. Manage the card afterwards with Update partner card and Cancel partner card.

🚧

Available on request

Partner cards must be enabled for your business; until then every partner card endpoint returns 403. Email [email protected] to get started.

❗

Always send an Idempotency-Key

If you repeat an identical request without an Idempotency-Key, the call returns the same card with 201 but moves the amount from your balance again. The card's limit doesn't change. Send an Idempotency-Key and reuse it when you retry.

You can issue up to 100 cards per day. Validation problems, such as an unknown user or an amount at or above that limit, return 422.

Body Params
number
required

The amount limit for the partner card.

string
required

Email of an existing user on your business. The user must have a verified phone number.

string

Your own reference, for example a booking the card is for. Returned on the card.

string

If set, opening the card's url requires a one-time code sent to this address. Not returned on the card.

number

Maximum number of transactions allowed on the card.

string

Optional display name for the card. Defaults to "Partner card" when omitted.

Headers
string

A unique key, such as a UUID, that makes it safe to retry this request. Reuse the same key when you retry. See Idempotency.

Responses

404

Invalid request

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json