{ "components": { "responses": { "errors": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/errors" } } }, "description": "General Error" } }, "schemas": { "payment_notification-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "and": { "items": { "$ref": "#/components/schemas/payment_notification-filter" }, "type": "array", "uniqueItems": true }, "bank": { "$ref": "#/components/schemas/payment_notification-filter-bank" }, "channel_type": { "$ref": "#/components/schemas/payment_notification-filter-channel_type" }, "device_uuid": { "$ref": "#/components/schemas/payment_notification-filter-device_uuid" }, "extracted_amount": { "$ref": "#/components/schemas/payment_notification-filter-extracted_amount" }, "extracted_reference": { "$ref": "#/components/schemas/payment_notification-filter-extracted_reference" }, "extracted_sender_name": { "$ref": "#/components/schemas/payment_notification-filter-extracted_sender_name" }, "id": { "$ref": "#/components/schemas/payment_notification-filter-id" }, "inserted_at": { "$ref": "#/components/schemas/payment_notification-filter-inserted_at" }, "matched_payment_id": { "$ref": "#/components/schemas/payment_notification-filter-matched_payment_id" }, "not": { "$ref": "#/components/schemas/payment_notification-filter" }, "or": { "items": { "$ref": "#/components/schemas/payment_notification-filter" }, "type": "array", "uniqueItems": true }, "package_name": { "$ref": "#/components/schemas/payment_notification-filter-package_name" }, "raw_message": { "$ref": "#/components/schemas/payment_notification-filter-raw_message" }, "received_timestamp": { "$ref": "#/components/schemas/payment_notification-filter-received_timestamp" }, "sender": { "$ref": "#/components/schemas/payment_notification-filter-sender" }, "status": { "$ref": "#/components/schemas/payment_notification-filter-status" }, "title": { "$ref": "#/components/schemas/payment_notification-filter-title" }, "updated_at": { "$ref": "#/components/schemas/payment_notification-filter-updated_at" } }, "type": "deepObject" }, "payment-filter-reference": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification-filter-extracted_amount": { "additionalProperties": false, "properties": { "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" } }, "type": "object" }, "payment-filter-origin_full_phone": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-service": { "additionalProperties": false, "properties": { "eq": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, "greater_than": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, "greater_than_or_equal": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, "less_than_or_equal": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, "not_eq": { "enum": [ "axox_geo", "axox_broker" ], "type": "string" } }, "type": "object" }, "payment-filter-origin_phone_prefix": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/link" }, "type": "object" }, "payment_notification-filter-status": { "additionalProperties": false, "properties": { "eq": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, "greater_than": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, "greater_than_or_equal": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, "less_than_or_equal": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, "not_eq": { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" } }, "type": "object" }, "payment_notification-filter-bank": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification-filter-received_timestamp": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter": { "additionalProperties": false, "description": "Filters the query to results matching the given filter object", "example": "", "properties": { "amount": { "$ref": "#/components/schemas/payment-filter-amount" }, "and": { "items": { "$ref": "#/components/schemas/payment-filter" }, "type": "array", "uniqueItems": true }, "currency": { "$ref": "#/components/schemas/payment-filter-currency" }, "customer_email": { "$ref": "#/components/schemas/payment-filter-customer_email" }, "customer_id_doc": { "$ref": "#/components/schemas/payment-filter-customer_id_doc" }, "description": { "$ref": "#/components/schemas/payment-filter-description" }, "id": { "$ref": "#/components/schemas/payment-filter-id" }, "inserted_at": { "$ref": "#/components/schemas/payment-filter-inserted_at" }, "matched_at": { "$ref": "#/components/schemas/payment-filter-matched_at" }, "metadata": { "$ref": "#/components/schemas/payment-filter-metadata" }, "not": { "$ref": "#/components/schemas/payment-filter" }, "or": { "items": { "$ref": "#/components/schemas/payment-filter" }, "type": "array", "uniqueItems": true }, "origin_full_phone": { "$ref": "#/components/schemas/payment-filter-origin_full_phone" }, "origin_phone_number": { "$ref": "#/components/schemas/payment-filter-origin_phone_number" }, "origin_phone_prefix": { "$ref": "#/components/schemas/payment-filter-origin_phone_prefix" }, "payment_notification_id": { "$ref": "#/components/schemas/payment-filter-payment_notification_id" }, "reference": { "$ref": "#/components/schemas/payment-filter-reference" }, "service": { "$ref": "#/components/schemas/payment-filter-service" }, "status": { "$ref": "#/components/schemas/payment-filter-status" }, "updated_at": { "$ref": "#/components/schemas/payment-filter-updated_at" } }, "type": "deepObject" }, "payment_notification-filter-matched_payment_id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "payment-filter-updated_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "payment_notification-filter-sender": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification-filter-raw_message": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-amount": { "additionalProperties": false, "properties": { "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" } }, "type": "object" }, "link": { "description": "A link MUST be represented as either: a string containing the link's URL or a link object.", "type": "string" }, "payment_notification-filter-inserted_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "payment_notification-filter-extracted_reference": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-origin_phone_number": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification-filter-extracted_sender_name": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-currency": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification-filter-device_uuid": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-description": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "error": { "additionalProperties": false, "properties": { "code": { "description": "An application-specific error code, expressed as a string value.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "id": { "description": "A unique identifier for this particular occurrence of the problem.", "type": "string" }, "links": { "$ref": "#/components/schemas/links" }, "source": { "properties": { "parameter": { "description": "A string indicating which query parameter caused the error.", "type": "string" }, "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", "type": "string" } }, "type": "object" }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.", "type": "string" } }, "type": "object" }, "payment_notification-filter-channel_type": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment_notification": { "additionalProperties": false, "description": "A \"Resource object\" representing a payment_notification", "properties": { "attributes": { "additionalProperties": false, "description": "An attributes object for a payment_notification", "properties": { "bank": { "description": "Field included by default.", "type": "string" }, "channel_type": { "description": "Field included by default.", "type": "string" }, "device_uuid": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "extracted_amount": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "extracted_reference": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "extracted_sender_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "inserted_at": { "description": "Field included by default." }, "matched_payment_id": { "anyOf": [ { "format": "uuid", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "package_name": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "raw_message": { "description": "Field included by default.", "type": "string" }, "received_timestamp": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "sender": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "status": { "anyOf": [ { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "title": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "updated_at": { "description": "Field included by default." } }, "required": [ "bank", "channel_type", "raw_message", "inserted_at", "updated_at" ], "type": "object" }, "id": { "type": "string" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a payment_notification", "properties": {}, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "errors": { "items": { "$ref": "#/components/schemas/error" }, "type": "array", "uniqueItems": true }, "payment_notification-filter-title": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-customer_id_doc": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment": { "additionalProperties": false, "description": "A \"Resource object\" representing a payment", "properties": { "attributes": { "additionalProperties": false, "description": "An attributes object for a payment", "properties": { "amount": { "description": "Field included by default.", "type": "string" }, "currency": { "description": "Field included by default.", "type": "string" }, "customer_email": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "customer_id_doc": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "description": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "inserted_at": { "description": "Field included by default." }, "matched_at": { "anyOf": [ {}, { "type": "null" } ], "description": "Field included by default." }, "metadata": { "description": "Field included by default.", "type": "object" }, "origin_full_phone": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "origin_phone_number": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "origin_phone_prefix": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "payment_notification_id": { "anyOf": [ { "format": "uuid", "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "reference": { "anyOf": [ { "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "service": { "anyOf": [ { "enum": [ "axox_geo", "axox_broker" ], "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "status": { "anyOf": [ { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "nullable": true, "type": "string" }, { "type": "null" } ], "description": "Field included by default." }, "updated_at": { "description": "Field included by default." } }, "required": [ "amount", "currency", "metadata", "inserted_at", "updated_at" ], "type": "object" }, "id": { "type": "string" }, "relationships": { "additionalProperties": false, "description": "A relationships object for a payment", "properties": {}, "type": "object" }, "type": { "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "payment_notification-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "payment-filter-inserted_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "payment_notification-filter-package_name": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-matched_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "payment_notification-filter-updated_at": { "additionalProperties": false, "properties": { "eq": {}, "greater_than": {}, "greater_than_or_equal": {}, "in": { "items": {}, "type": "array" }, "is_distinct_from": {}, "is_nil": { "type": "boolean" }, "is_not_distinct_from": {}, "less_than": {}, "less_than_or_equal": {}, "not_eq": {} }, "type": "object" }, "payment-filter-customer_email": { "additionalProperties": false, "properties": { "contains": { "type": "string" }, "eq": { "type": "string" }, "greater_than": { "type": "string" }, "greater_than_or_equal": { "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "type": "string" }, "less_than_or_equal": { "type": "string" }, "not_eq": { "type": "string" }, "string_ends_with": { "type": "string" }, "string_starts_with": { "type": "string" } }, "type": "object" }, "payment-filter-metadata": { "additionalProperties": false, "properties": { "eq": { "type": "object" }, "greater_than": { "type": "object" }, "greater_than_or_equal": { "type": "object" }, "in": { "items": { "type": "object" }, "type": "array" }, "is_distinct_from": { "type": "object" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "object" }, "less_than": { "type": "object" }, "less_than_or_equal": { "type": "object" }, "not_eq": { "type": "object" } }, "type": "object" }, "payment-filter-id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "payment-filter-payment_notification_id": { "additionalProperties": false, "properties": { "eq": { "format": "uuid", "type": "string" }, "greater_than": { "format": "uuid", "type": "string" }, "greater_than_or_equal": { "format": "uuid", "type": "string" }, "in": { "items": { "format": "uuid", "type": "string" }, "type": "array" }, "is_distinct_from": { "format": "uuid", "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "format": "uuid", "type": "string" }, "less_than": { "format": "uuid", "type": "string" }, "less_than_or_equal": { "format": "uuid", "type": "string" }, "not_eq": { "format": "uuid", "type": "string" } }, "type": "object" }, "payment-filter-status": { "additionalProperties": false, "properties": { "eq": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, "greater_than": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, "greater_than_or_equal": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, "in": { "items": { "type": "string" }, "type": "array" }, "is_distinct_from": { "type": "string" }, "is_nil": { "type": "boolean" }, "is_not_distinct_from": { "type": "string" }, "less_than": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, "less_than_or_equal": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, "not_eq": { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "bearerFormat": "JWT", "description": "JWT for bearer authentication", "scheme": "bearer", "type": "http" } } }, "info": { "title": "Open API Specification", "version": "1.1" }, "openapi": "3.0.0", "paths": { "/api/v1/notifications": { "get": { "callbacks": {}, "deprecated": false, "description": "/notifications operation on payment_notification resource", "parameters": [ { "description": "Filters the query to results with attributes matching the given filter object", "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/payment_notification-filter" }, "style": "deepObject" }, { "description": "Sort order to apply to the results", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "pattern": "^(id|-id|\\+\\+id|--id|bank|-bank|\\+\\+bank|--bank|channel_type|-channel_type|\\+\\+channel_type|--channel_type|title|-title|\\+\\+title|--title|sender|-sender|\\+\\+sender|--sender|raw_message|-raw_message|\\+\\+raw_message|--raw_message|extracted_reference|-extracted_reference|\\+\\+extracted_reference|--extracted_reference|extracted_amount|-extracted_amount|\\+\\+extracted_amount|--extracted_amount|extracted_sender_name|-extracted_sender_name|\\+\\+extracted_sender_name|--extracted_sender_name|package_name|-package_name|\\+\\+package_name|--package_name|device_uuid|-device_uuid|\\+\\+device_uuid|--device_uuid|received_timestamp|-received_timestamp|\\+\\+received_timestamp|--received_timestamp|status|-status|\\+\\+status|--status|matched_payment_id|-matched_payment_id|\\+\\+matched_payment_id|--matched_payment_id|inserted_at|-inserted_at|\\+\\+inserted_at|--inserted_at|updated_at|-updated_at|\\+\\+updated_at|--updated_at)(,(id|-id|\\+\\+id|--id|bank|-bank|\\+\\+bank|--bank|channel_type|-channel_type|\\+\\+channel_type|--channel_type|title|-title|\\+\\+title|--title|sender|-sender|\\+\\+sender|--sender|raw_message|-raw_message|\\+\\+raw_message|--raw_message|extracted_reference|-extracted_reference|\\+\\+extracted_reference|--extracted_reference|extracted_amount|-extracted_amount|\\+\\+extracted_amount|--extracted_amount|extracted_sender_name|-extracted_sender_name|\\+\\+extracted_sender_name|--extracted_sender_name|package_name|-package_name|\\+\\+package_name|--package_name|device_uuid|-device_uuid|\\+\\+device_uuid|--device_uuid|received_timestamp|-received_timestamp|\\+\\+received_timestamp|--received_timestamp|status|-status|\\+\\+status|--status|matched_payment_id|-matched_payment_id|\\+\\+matched_payment_id|--matched_payment_id|inserted_at|-inserted_at|\\+\\+inserted_at|--inserted_at|updated_at|-updated_at|\\+\\+updated_at|--updated_at))*$", "type": "string" }, "style": "form" }, { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "example": { "limit": 25 }, "properties": { "after": { "type": "string" }, "before": { "type": "string" }, "count": { "default": false, "type": "boolean" }, "limit": { "minimum": 1, "type": "integer" }, "offset": { "minimum": 0, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment_notification": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at" }, "properties": { "payment_notification": { "description": "Comma separated field names for payment_notification", "example": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "description": "An array of resource objects representing a payment_notification", "items": { "$ref": "#/components/schemas/payment_notification" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment_notification" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "/notifications operation on payment_notification resource", "parameters": [ { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment_notification": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at" }, "properties": { "payment_notification": { "description": "Comma separated field names for payment_notification", "example": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "bank": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "device_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "extracted_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "extracted_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "extracted_sender_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matched_payment_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "package_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "raw_message": { "type": "string" }, "received_timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sender": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "raw_message" ], "type": "object" }, "relationships": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": { "enum": [ "payment_notification" ] } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for the /notifications operation on payment_notification resource", "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment_notification" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment_notification" ] } }, "/api/v1/notifications/{id}": { "delete": { "callbacks": {}, "deprecated": false, "description": "/notifications/:id operation on payment_notification resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment_notification": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at" }, "properties": { "payment_notification": { "description": "Comma separated field names for payment_notification", "example": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "description": "Deleted successfully" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment_notification" ] }, "get": { "callbacks": {}, "deprecated": false, "description": "/notifications/:id operation on payment_notification resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment_notification": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at" }, "properties": { "payment_notification": { "description": "Comma separated field names for payment_notification", "example": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment_notification" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment_notification" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "/notifications/:id operation on payment_notification resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment_notification": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at" }, "properties": { "payment_notification": { "description": "Comma separated field names for payment_notification", "example": "id,bank,channel_type,title,sender,raw_message,extracted_reference,extracted_amount,extracted_sender_name,package_name,device_uuid,received_timestamp,status,matched_payment_id,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "extracted_amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "extracted_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "extracted_sender_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matched_payment_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "enum": [ "unmatched", "matched", "ignored", "duplicate" ], "type": "string" }, { "type": "null" } ] } }, "type": "object" }, "id": { "type": "string" }, "relationships": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": { "enum": [ "payment_notification" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for the /notifications/:id operation on payment_notification resource", "required": false }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment_notification" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment_notification" ] } }, "/api/v1/payments": { "get": { "callbacks": {}, "deprecated": false, "description": "/payments operation on payment resource", "parameters": [ { "description": "Filters the query to results with attributes matching the given filter object", "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/payment-filter" }, "style": "deepObject" }, { "description": "Sort order to apply to the results", "explode": false, "in": "query", "name": "sort", "required": false, "schema": { "pattern": "^(id|-id|\\+\\+id|--id|customer_id_doc|-customer_id_doc|\\+\\+customer_id_doc|--customer_id_doc|customer_email|-customer_email|\\+\\+customer_email|--customer_email|service|-service|\\+\\+service|--service|amount|-amount|\\+\\+amount|--amount|currency|-currency|\\+\\+currency|--currency|origin_phone_prefix|-origin_phone_prefix|\\+\\+origin_phone_prefix|--origin_phone_prefix|origin_phone_number|-origin_phone_number|\\+\\+origin_phone_number|--origin_phone_number|origin_full_phone|-origin_full_phone|\\+\\+origin_full_phone|--origin_full_phone|reference|-reference|\\+\\+reference|--reference|status|-status|\\+\\+status|--status|payment_notification_id|-payment_notification_id|\\+\\+payment_notification_id|--payment_notification_id|matched_at|-matched_at|\\+\\+matched_at|--matched_at|description|-description|\\+\\+description|--description|metadata|-metadata|\\+\\+metadata|--metadata|inserted_at|-inserted_at|\\+\\+inserted_at|--inserted_at|updated_at|-updated_at|\\+\\+updated_at|--updated_at)(,(id|-id|\\+\\+id|--id|customer_id_doc|-customer_id_doc|\\+\\+customer_id_doc|--customer_id_doc|customer_email|-customer_email|\\+\\+customer_email|--customer_email|service|-service|\\+\\+service|--service|amount|-amount|\\+\\+amount|--amount|currency|-currency|\\+\\+currency|--currency|origin_phone_prefix|-origin_phone_prefix|\\+\\+origin_phone_prefix|--origin_phone_prefix|origin_phone_number|-origin_phone_number|\\+\\+origin_phone_number|--origin_phone_number|origin_full_phone|-origin_full_phone|\\+\\+origin_full_phone|--origin_full_phone|reference|-reference|\\+\\+reference|--reference|status|-status|\\+\\+status|--status|payment_notification_id|-payment_notification_id|\\+\\+payment_notification_id|--payment_notification_id|matched_at|-matched_at|\\+\\+matched_at|--matched_at|description|-description|\\+\\+description|--description|metadata|-metadata|\\+\\+metadata|--metadata|inserted_at|-inserted_at|\\+\\+inserted_at|--inserted_at|updated_at|-updated_at|\\+\\+updated_at|--updated_at))*$", "type": "string" }, "style": "form" }, { "description": "Paginates the response with the limit and offset or keyset pagination.", "in": "query", "name": "page", "required": false, "schema": { "example": { "limit": 25 }, "properties": { "after": { "type": "string" }, "before": { "type": "string" }, "count": { "default": false, "type": "boolean" }, "limit": { "minimum": 1, "type": "integer" }, "offset": { "minimum": 0, "type": "integer" } }, "type": "object" }, "style": "deepObject" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at" }, "properties": { "payment": { "description": "Comma separated field names for payment", "example": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "description": "An array of resource objects representing a payment", "items": { "$ref": "#/components/schemas/payment" }, "type": "array", "uniqueItems": true }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } }, "type": "object" } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment" ] }, "post": { "callbacks": {}, "deprecated": false, "description": "/payments operation on payment resource", "parameters": [ { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at" }, "properties": { "payment": { "description": "Comma separated field names for payment", "example": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customer_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "customer_id_doc": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matched_at": { "anyOf": [ {}, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "origin_full_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_phone_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "payment_notification_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "service": { "anyOf": [ { "enum": [ "axox_geo", "axox_broker" ], "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, { "type": "null" } ] } }, "type": "object" }, "relationships": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": { "enum": [ "payment" ] } }, "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for the /payments operation on payment resource", "required": false }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment" ] } }, "/api/v1/payments/{id}": { "delete": { "callbacks": {}, "deprecated": false, "description": "/payments/:id operation on payment resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at" }, "properties": { "payment": { "description": "Comma separated field names for payment", "example": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "description": "Deleted successfully" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment" ] }, "get": { "callbacks": {}, "deprecated": false, "description": "/payments/:id operation on payment resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at" }, "properties": { "payment": { "description": "Comma separated field names for payment", "example": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment" ] }, "patch": { "callbacks": {}, "deprecated": false, "description": "/payments/:id operation on payment resource", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "style": "form" }, { "description": "Relationship paths to include in the response", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "pattern": "^()(,())*$", "type": "string" }, "style": "form" }, { "description": "Limits the response fields to only those listed for each type", "in": "query", "name": "fields", "required": false, "schema": { "additionalProperties": true, "example": { "payment": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at" }, "properties": { "payment": { "description": "Comma separated field names for payment", "example": "id,customer_id_doc,customer_email,service,amount,currency,origin_phone_prefix,origin_phone_number,origin_full_phone,reference,status,payment_notification_id,matched_at,description,metadata,inserted_at,updated_at", "type": "string" } }, "type": "object" }, "style": "deepObject" } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "attributes": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matched_at": { "anyOf": [ {}, { "type": "null" } ] }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "payment_notification_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "enum": [ "pending_verification", "approved", "rejected", "manual_review" ], "type": "string" }, { "type": "null" } ] } }, "type": "object" }, "id": { "type": "string" }, "relationships": { "additionalProperties": false, "properties": {}, "type": "object" }, "type": { "enum": [ "payment" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "Request body for the /payments/:id operation on payment resource", "required": false }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/payment" }, "included": { "items": { "oneOf": [] }, "type": "array", "uniqueItems": true }, "meta": { "additionalProperties": true, "type": "object" } } } } }, "description": "Success" }, "default": { "$ref": "#/components/responses/errors" } }, "tags": [ "payment" ] } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "http://localhost:4000", "variables": {} } ], "tags": [] }