{ "openapi": "3.0.4", "info": { "title": "Debitdirect.API", "version": "1.0" }, "paths": { "/Customers/{customerIdOrHandle}": { "put": { "tags": [ "Customers" ], "parameters": [ { "name": "CustomerIdOrHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Customers" ], "parameters": [ { "name": "customerIdOrHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Customers": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerPaginationContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPaginationContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPaginationContainer" } } } } } }, "post": { "tags": [ "Customers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Command" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Command" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Command" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Customers/{customerId}": { "delete": { "tags": [ "Customers" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Customers/mandates": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MandatePaginationContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MandatePaginationContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MandatePaginationContainer" } } } } } } }, "/Customers/mandates/{mandateIdOrHandle}": { "get": { "tags": [ "Customers" ], "parameters": [ { "name": "mandateIdOrHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/": { "get": { "tags": [ "Debitdirect.API" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/Merchants": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMerchantCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMerchantCommand" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Merchants" ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Merchant" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Merchant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Merchant" } } } } } } }, "/Merchants/agreements": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgreementCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAgreementCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAgreementCommand" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Merchants/agreements/{agreementIdOrHandle}": { "get": { "tags": [ "Merchants" ], "parameters": [ { "name": "agreementIdOrHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Merchants/agreements/{agreementId}": { "delete": { "tags": [ "Merchants" ], "parameters": [ { "name": "agreementId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Merchants/webhooks": { "get": { "tags": [ "Merchants" ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookPaginationContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPaginationContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookPaginationContainer" } } } } } } }, "/Merchants/webhooks/unsubscribe": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeWebhookCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnSubscribeWebhookCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnSubscribeWebhookCommand" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Merchants/webhooks/subscribe": { "post": { "tags": [ "Merchants" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeWebhookCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubscribeWebhookCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubscribeWebhookCommand" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Payments": { "get": { "tags": [ "Payments" ], "parameters": [ { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "orderby", "in": "query", "schema": { "type": "string" } }, { "name": "after", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentListItemPaginationContainer" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentListItemPaginationContainer" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentListItemPaginationContainer" } } } } } }, "post": { "tags": [ "Payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentCommand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentCommand" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePaymentCommand" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "428": { "description": "Precondition Required", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Payments/{paymentIdOrHandle}": { "get": { "tags": [ "Payments" ], "parameters": [ { "name": "paymentIdOrHandle", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Payment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/Payments/{paymentId}": { "delete": { "tags": [ "Payments" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeletePaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeletePaymentRequest" } } } }, "responses": { "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "202": { "description": "Accepted" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AgreementStateEnum": { "enum": [ "Active", "PendingActivation", "InActive" ], "type": "string" }, "Command": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAgreementCommand": { "type": "object", "properties": { "scheme": { "type": "string", "nullable": true }, "schemeData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "test": { "type": "boolean", "nullable": true }, "dataSourceHandle": { "type": "string", "nullable": true }, "merchantId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CreateMerchantCommand": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isvHandle": { "type": "string", "nullable": true }, "metaData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreatePaymentCommand": { "type": "object", "properties": { "mandate": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Customer": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "handle": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "mandates": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerMandate" }, "nullable": true } }, "additionalProperties": false }, "CustomerMandate": { "type": "object", "properties": { "handle": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/MandateStateEnum" } }, "additionalProperties": false }, "CustomerPaginationContainer": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" }, "nullable": true, "readOnly": true }, "nextOffset": { "type": "string", "nullable": true, "readOnly": true }, "hasMore": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DeletePaymentRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Mandate": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "handle": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/MandateStateEnum" }, "schemeData": { "type": "array", "items": { }, "nullable": true }, "customer": { "$ref": "#/components/schemas/MandateCustomer" } }, "additionalProperties": false }, "MandateCustomer": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "handle": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MandatePaginationContainer": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Mandate" }, "nullable": true, "readOnly": true }, "nextOffset": { "type": "string", "nullable": true, "readOnly": true }, "hasMore": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "MandateStateEnum": { "enum": [ "Created", "PendingProcess", "PendingVerification", "Active", "Cancelled" ], "type": "string" }, "Merchant": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "handle": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/MerchantStateEnum" }, "createdAt": { "type": "string", "format": "date-time" }, "apiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantApiKey" }, "nullable": true }, "agreements": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantAgreement" }, "nullable": true } }, "additionalProperties": false }, "MerchantAgreement": { "type": "object", "properties": { "scheme": { "type": "string", "nullable": true }, "handle": { "type": "string", "nullable": true }, "state": { "$ref": "#/components/schemas/AgreementStateEnum" }, "schemeData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "MerchantApiKey": { "type": "object", "properties": { "token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantStateEnum": { "enum": [ "Active", "PendingActivation", "InActive" ], "type": "string" }, "Payment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "paymentDate": { "type": "string", "format": "date-time" }, "scheduleDate": { "type": "string", "format": "date-time", "nullable": true }, "handle": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "nullable": true }, "test": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PaymentStatusEnum" }, "statusText": { "type": "string", "nullable": true }, "settlementDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "mandate": { "$ref": "#/components/schemas/PaymentMandate" } }, "additionalProperties": false }, "PaymentCustomerListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "paymentDate": { "type": "string", "format": "date-time" }, "scheduleDate": { "type": "string", "format": "date-time", "nullable": true }, "handle": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "nullable": true }, "test": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PaymentStatusEnum" }, "settlementDate": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "customer": { "$ref": "#/components/schemas/PaymentCustomerListItem" }, "mandate": { "$ref": "#/components/schemas/PaymentMandateListItem" } }, "additionalProperties": false }, "PaymentListItemPaginationContainer": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentListItem" }, "nullable": true, "readOnly": true }, "nextOffset": { "type": "string", "nullable": true, "readOnly": true }, "hasMore": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PaymentMandate": { "type": "object", "properties": { "handle": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/MandateStateEnum" }, "customerId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "PaymentMandateListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "handle": { "type": "string", "nullable": true }, "scheme": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentStatusEnum": { "enum": [ "Pending", "Settled", "Scheduled", "Rejected", "Cancelled", "Chargeback", "PendingCancel" ], "type": "string" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "SubscribeWebhookCommand": { "type": "object", "properties": { "webhookUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UnSubscribeWebhookCommand": { "type": "object", "properties": { "webhookUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCustomerBody": { "required": [ "name", "number" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "nullable": true }, "handle": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WebhookPaginationContainer": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" }, "nullable": true, "readOnly": true }, "nextOffset": { "type": "string", "nullable": true, "readOnly": true }, "hasMore": { "type": "boolean", "readOnly": true } }, "additionalProperties": false } } } }