Billiecart API

<back to all web services

DeletePaymentRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
DELETE/payments/{Id}
import 'package:servicestack/servicestack.dart';

abstract class DeleteOperationUnTenanted<TResponse> implements IDelete
{
    DeleteOperationUnTenanted();
    DeleteOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "DeleteOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class DeleteOperationTenanted<TResponse> extends DeleteOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    DeleteOperationTenanted({this.organisationId});
    DeleteOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "DeleteOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class DeletePaymentResponse implements IConvertible
{
    ResponseStatus? responseStatus;

    DeletePaymentResponse({this.responseStatus});
    DeletePaymentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "DeletePaymentResponse";
    TypeContext? context = _ctx;
}

class DeletePaymentRequest extends DeleteOperationTenanted<DeletePaymentResponse> implements IConvertible
{
    String? id;

    DeletePaymentRequest({this.id});
    DeletePaymentRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id
    });

    getTypeName() => "DeletePaymentRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'DeleteOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'DeleteOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'DeletePaymentResponse': TypeInfo(TypeOf.Class, create:() => DeletePaymentResponse()),
    'DeletePaymentRequest': TypeInfo(TypeOf.Class, create:() => DeletePaymentRequest()),
});

Dart DeletePaymentRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /payments/{Id} HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}