Consumers

Create Consumer

Changed on Oct 28, 2026

Create a new consumer with contact information and payment details.

post/api/v2/consumers

Request

Base URL
https://stream-app-service.streampay.sa
Auth
- HTTP bearer
- or API key in header x-api-key

Request body

namestring required

Consumer name

phone_numberstring phone nullable

Phone number

emailstring email nullable

Email address

external_idstring nullable

External ID

ibanstring nullable

IBAN

aliasstring nullable

Alias

commentstring nullable

Comment

preferred_language'AR' | 'EN'

communication_methodsConsumerCommunicationMethod[] nullable

Communication methods

consumer_type'INDIVIDUAL' | 'BUSINESS'

vat_numberstring nullable

VAT number (optional for business type)

commercial_registrationstring nullable

Commercial registration number (optional for business type)

fieldsobject

Catalog field values for this consumer (keys from GET /resource-fields?resource_type=consumer)

external_metadataExternalMetadataStorage

Response

Successful Response

idstring uuid4

Unique identifier (UUID) of the organization consumer

namestring

Name of the consumer

phone_numberstring phone nullable

Phone number of the consumer

emailstring email nullable

Email address of the consumer

external_idstring nullable

External identifier for the consumer

ibanstring nullable

IBAN (International Bank Account Number) of the consumer

is_deletedboolean

Whether the consumer has been deleted

aliasstring nullable

Alias of the consumer

created_atstring date-time

Date and time when the consumer was created

commentstring nullable

Additional comments or notes about the consumer

communication_methodsConsumerCommunicationMethod[]

Preferred communication methods for the consumer