BokaMera.API.Host

<back to all web services

AddPaysonApiSettings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/payment/payson/apisettingsAdd payson api settingsAdd payson api settings for the logged in company

export class PaysonApiSettingsQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description The payson security user id */
    // @ApiMember(Description="The payson security user id")
    public SecurityUserId: string;

    /** @description The payson security user password */
    // @ApiMember(Description="The payson security user password")
    public SecurityPassword: string;

    /** @description The payson receiver email */
    // @ApiMember(Description="The payson receiver email")
    public ReceiverEmail: string;

    /** @description The payson receiver firstname */
    // @ApiMember(Description="The payson receiver firstname")
    public ReceiverFirstname: string;

    /** @description The payson receiver lastname */
    // @ApiMember(Description="The payson receiver lastname")
    public ReceiverLastname: string;

    public constructor(init?: Partial<PaysonApiSettingsQueryResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class AddPaysonApiSettings implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description The payson security user id */
    // @ApiMember(Description="The payson security user id", IsRequired=true)
    public SecurityUserId: string;

    /** @description The payson security user password */
    // @ApiMember(Description="The payson security user password", IsRequired=true)
    public SecurityPassword: string;

    /** @description The payson receiver email */
    // @ApiMember(Description="The payson receiver email", IsRequired=true)
    public ReceiverEmail: string;

    /** @description The payson receiver firstname */
    // @ApiMember(Description="The payson receiver firstname", IsRequired=true)
    public ReceiverFirstname: string;

    /** @description The payson receiver lastname */
    // @ApiMember(Description="The payson receiver lastname", IsRequired=true)
    public ReceiverLastname: string;

    public constructor(init?: Partial<AddPaysonApiSettings>) { (Object as any).assign(this, init); }
}

TypeScript AddPaysonApiSettings DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/payson/apisettings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","SecurityUserId":"String","SecurityPassword":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"SecurityUserId":"String","SecurityPassword":"String","ReceiverEmail":"String","ReceiverFirstname":"String","ReceiverLastname":"String"}