openapi: "3.0.0" info: title: "Safepay" version: "1.0.0" description: "Safepay is a regulated payments service provider that enables developers to orchestrate money movement between customers and businesses with ease and speed. The Safepay API makes it simple for businesses and financial platforms to create payment sessions, manage subscriptions, issue invoices and exchange value by sending and receiving money. Our API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes.\n\nSafepay offers two environments to developers - `production` and `sandbox` . Any transaction performed in our `sandbox` environment will not have any financial impact. We also provide test credentials for payment instruments that can be used while integrating.\n\nTo begin integrating, we recommend you sign up for our sandbox account - its free to do so and will give you access to all of Safepay's APIs. Once you've completed your integration, please reach out to a member of our team who will guide you on how to create a production account and complete our onboarding process." servers: - url: "https://api.sandbox.safepay.com" description: "Sandbox environment" - url: "https://api.safepay.com" description: "Production environment" paths: "/v1/company/login": post: summary: "Login Company" responses: "200": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Encoding": schema: type: "string" example: "gzip" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Wed, 30 Nov 2022 05:59:04 GMT" "Server": schema: type: "string" example: "nginx/1.19.1" "Vary": schema: type: "string" example: "Accept-Encoding" "X-Ratelimit-Limit": schema: type: "integer" example: "50" "X-Ratelimit-Remaining": schema: type: "integer" example: "49" "X-Ratelimit-Reset": schema: type: "string" example: "Wed, 30 Nov 2022 06:00:03 UTC" "Content-Length": schema: type: "integer" example: "340" "Connection": schema: type: "string" example: "keep-alive" description: "Login Company" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "count": type: "integer" "list": type: "array" items: type: "object" properties: "token": type: "string" "name": type: "string" "description": type: "string" "email": type: "string" format: "email" "phone": type: "string" "api_key": type: "string" "avatar": type: "string" "website": type: "string" "payout_terms": type: "string" "active": type: "integer" "suspended": type: "integer" "suspend_reason": type: "string" "email_settings": nullable: true "api_settings": nullable: true "organization": nullable: true "verification": nullable: true "verified": type: "integer" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/Error" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/Error" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/Error" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/Error" x-speakeasy-group: "company" x-speakeasy-name-override: "login" "/auth/v1/company/authenticate": post: summary: "Create Merchant JWT" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:13:14 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db365f3d8cc914-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "session": type: "string" "token": type: "string" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:14:22 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "89" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db3812ccffc914-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "417": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:13:45 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "97" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db372ff950c914-KHI" description: "417" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "client": type: "string" "email": type: "string" format: "email" "password": type: "string" required: true x-speakeasy-group: "auth" x-speakeasy-name-override: "createMerchantJwt" "/auth/v2/user/login": post: summary: "Create Shopper JWT Using Password" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:20:12 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab4457b5918d1f4-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "session": type: "string" "token": type: "string" "refresh_token": type: "string" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:19:24 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Content-Length": schema: type: "integer" example: "115" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab4444e8aafd1f4-MCT" description: "400" content: "application/json": schema: type: "object" properties: "code": type: "string" "message": type: "string" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:19:56 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Content-Length": schema: type: "integer" example: "121" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization, X-SFPY-MERCHANT-KEY" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab445138880d1f4-MCT" description: "401" content: "application/json": schema: type: "object" properties: "code": type: "string" "message": type: "string" "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "type": type: "string" "email": type: "string" format: "email" "password": type: "string" required: true x-speakeasy-group: "auth" x-speakeasy-name-override: "login" "/user/v1/guest": post: summary: "Create Guest JWT" responses: "200": headers: "Date": schema: type: "string" example: "Sat, 07 Oct 2023 07:11:17 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8124543919b7d1cc-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "session": type: "string" "token": type: "string" "status": $ref: "#/components/schemas/Status" "417": headers: "Date": schema: type: "string" example: "Sat, 07 Oct 2023 07:12:24 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "96" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "812455e39817d1cc-MCT" description: "417" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "country": type: "string" "phone": type: "string" format: "utc-millisec" required: true x-speakeasy-group: "users" x-speakeasy-name-override: "createGuestJwt" "/client/api-settings/v1": post: summary: "Create API Key" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:37:38 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db5a269f57c972-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "client_id": type: "string" "webhook_secret": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:34:17 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "78" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db55416a80c972-KHI" description: "400" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:34:40 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "111" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db55d019a8c972-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "apiKeys" x-speakeasy-name-override: "create" get: summary: "Find Api Key" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:52:48 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db705b6df8c904-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "client_id": type: "string" "webhook_secret": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 10:53:04 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "111" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db70c33f52c904-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "apiSettings" x-speakeasy-name-override: "getApiKey" put: summary: "Update Api Key" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 11:02:25 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db7e71fa77c919-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "client_id": type: "string" "webhook_secret": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 11:02:48 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "111" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80db7f06bf01c919-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "apiSettings" x-speakeasy-name-override: "updateKey" "/client/passport/v1/token": post: summary: "Generate Time-Based Token" responses: "200": headers: "Date": schema: type: "string" example: "Wed, 25 Oct 2023 11:15:11 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "81ba0a488a9dd1e4-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "string" "401": headers: "Date": schema: type: "string" example: "Wed, 25 Oct 2023 11:15:45 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "215" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "81ba0b206b91d1e4-MCT" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "passport" x-speakeasy-name-override: "generateToken" "/user/customers/v1": post: summary: "Create Customer" responses: "201": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 14:47:16 GMT" "Content-Length": schema: type: "integer" example: "428" description: "201" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "merchant_api_key": type: "string" "email": type: "string" format: "email" "first_name": type: "string" "last_name": type: "string" "phone_number": type: "string" format: "utc-millisec" "country": type: "string" "is_guest": type: "boolean" "is_deleted": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "status": $ref: "#/components/schemas/Status" "400": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 17:03:33 GMT" "Content-Length": schema: type: "integer" example: "108" description: "400" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "401": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 17:06:33 GMT" "Content-Length": schema: type: "integer" example: "222" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone_number": type: "string" format: "utc-millisec" "country": type: "string" required: true x-speakeasy-group: "customers" x-speakeasy-name-override: "create" get: summary: "List Customers" parameters: - name: "limit" in: "query" required: false example: "20" schema: type: "integer" - name: "page" in: "query" required: false example: "1" schema: type: "integer" responses: "200": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 18:41:30 GMT" "Content-Length": schema: type: "integer" example: "1785" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "customers": type: "array" items: type: "object" properties: "token": type: "string" "merchant_api_key": type: "string" "email": type: "string" format: "email" "first_name": type: "string" "last_name": type: "string" "phone_number": type: "string" format: "utc-millisec" "country": type: "string" "is_guest": type: "boolean" "is_deleted": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "count": type: "integer" "status": $ref: "#/components/schemas/Status" "400": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 18:42:16 GMT" "Content-Length": schema: type: "integer" example: "85" description: "400" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "401": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Sun, 22 Oct 2023 18:42:33 GMT" "Content-Length": schema: type: "integer" example: "222" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "customers" x-speakeasy-name-override: "list" "/user/address/v2": post: summary: "Create Address" responses: "201": headers: "Date": schema: type: "string" example: "Mon, 13 Nov 2023 18:06:02 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "379" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8258f23de8d8d1f4-MCT" description: "201" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "street1": type: "string" "street2": type: "string" "city": type: "string" "state": type: "string" "postal_code": type: "string" format: "utc-millisec" "country": type: "string" "is_default": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Mon, 13 Nov 2023 18:05:32 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "157" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8258f1800eefd1f4-MCT" description: "400" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Mon, 13 Nov 2023 18:06:24 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "222" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8258f2cb5c15d1f4-MCT" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "street1": type: "string" "street2": type: "string" "city": type: "string" "state": type: "string" "postal_code": type: "string" format: "utc-millisec" "country": type: "string" required: true x-speakeasy-group: "addresses" x-speakeasy-name-override: "create" "/order/payments/v3": post: summary: "Payment" responses: "201": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 12:07:26 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "626" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab53a700db4d1e8-MCT" description: "201 - flex" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "tracker": type: "object" properties: "token": type: "string" "client": type: "string" "environment": type: "string" "state": type: "string" "intent": type: "string" "mode": type: "string" "entry_mode": type: "string" "next_actions": type: "object" properties: "CYBERSOURCE": type: "object" properties: "kind": type: "string" "MPGS": type: "object" properties: "kind": type: "string" "purchase_totals": type: "object" properties: "quote_amount": type: "object" properties: "currency": type: "string" "amount": type: "integer" "base_amount": type: "object" properties: "currency": type: "string" "amount": type: "integer" "conversion_rate": type: "object" properties: "base_currency": type: "string" "quote_currency": type: "string" "rate": type: "integer" "metadata": type: "object" "capabilities": type: "object" properties: "CYBERSOURCE": type: "boolean" "MPGS": type: "boolean" "status": $ref: "#/components/schemas/Status" "400": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Fri, 06 Oct 2023 06:42:42 GMT" "Content-Length": schema: type: "integer" example: "133" description: "400" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "404": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Fri, 06 Oct 2023 06:42:13 GMT" "Content-Length": schema: type: "integer" example: "130" description: "404" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "500": headers: "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Date": schema: type: "string" example: "Fri, 06 Oct 2023 06:46:49 GMT" "Content-Length": schema: type: "integer" example: "74" description: "500" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "merchant_api_key": type: "string" "intent": type: "string" "mode": type: "string" "currency": type: "string" "amount": type: "integer" "entry_mode": type: "string" "metadata": type: "object" properties: "source": type: "string" "order_id": type: "string" required: true x-speakeasy-group: "orderPayments" x-speakeasy-name-override: "create" "/reporter/api/v1/payments": get: summary: "Search Payments" parameters: - name: "limit" in: "query" required: false description: "Limit search results to a value" example: "5" schema: type: "integer" - name: "page" in: "query" required: false description: "Paginate search results" example: "1" schema: type: "integer" - name: "sort_by" in: "query" required: false description: "Sort by specifies the field use to sort data e.g. `created_at`" example: "created_at" schema: type: "string" - name: "direction" in: "query" required: false description: "Direction specifies the data sort order either ASC or DESC" example: "DESC" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 24 Sep 2024 11:22:18 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8c8265583ad212ac-MRS" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "ok": type: "boolean" "data": type: "object" properties: "count": type: "integer" "list": type: "array" items: type: "object" properties: "token": type: "string" "environment": type: "string" "client": type: "object" properties: "api_key": type: "string" "customer": type: "object" properties: "token": type: "string" "state": type: "string" "intent": type: "string" "mode": type: "string" "currency": type: "string" "display_amount": type: "string" format: "utc-millisec" "created_at": type: "object" properties: "seconds": type: "integer" "meta": type: "object" properties: "limit": type: "integer" "page": type: "integer" "offset": type: "integer" "sort_by": type: "string" "direction": type: "string" "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "payments" x-speakeasy-name-override: "search" "/user/meta/v2/countries": get: summary: "Countries" parameters: - name: "lang" in: "query" required: false example: "en" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Wed, 23 Oct 2024 10:50:04 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8d712a017a25cdfd-SIN" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "api_version": type: "string" "data": type: "array" items: type: "object" properties: "code": type: "string" "name": type: "string" "status": $ref: "#/components/schemas/Status" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/Error" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/Error" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/Error" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/Error" x-speakeasy-group: "meta" x-speakeasy-name-override: "listCountries" "/user/meta/v2/country": get: summary: "Country" parameters: - name: "cc" in: "query" required: false example: "AE" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Wed, 23 Oct 2024 10:49:39 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8d7129612fb5cdfd-SIN" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "api_version": type: "string" "data": type: "object" properties: "required": type: "array" items: type: "string" "AdministrativeArea": type: "object" properties: "name": type: "string" "options": type: "array" items: type: "object" properties: "id": type: "string" "name": type: "string" "Locality": type: "object" properties: "name": type: "string" "StreetAddress": type: "object" properties: "name": type: "string" "PostCode": type: "object" properties: "name": type: "string" "status": $ref: "#/components/schemas/Status" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/Error" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/Error" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/Error" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/Error" x-speakeasy-group: "meta" x-speakeasy-name-override: "getCountry" "/client/hooks/v2/test": post: summary: "Test Webhook" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 30 Jan 2025 11:14:36 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "29" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "cf-cache-status": schema: type: "string" example: "DYNAMIC" "Report-To": schema: type: "string" example: "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=kvNvYPMhY8LfHMRVTiJwb%2B7KfmtxD%2BNLydk1ccYEzKREOdjLSUuU2dlRMLqlXVhGeUTnQyD2drUSkKIFVIW6AVHkqQEST%2FXRP6jWP79aAPcJx68q8Z49EZLk7ZcZNocsyDN1QJpzH6CbED14\"}],\"group\":\"cf-nel\",\"max_age\":604800}" "NEL": schema: type: "string" example: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}' "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "90a10a0d8e49e86a-KHI" "server-timing": schema: type: "string" example: 'cfL4;desc="?proto=TCP&rtt=28964&min_rtt=28911&rtt_var=10879&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2335&recv_bytes=1080&delivery_rate=99616&cwnd=251&unsent_bytes=0&cid=f4525ef55750a521&ts=989&x=0"' description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "is_success": type: "boolean" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Thu, 30 Jan 2025 11:15:06 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "139" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "cf-cache-status": schema: type: "string" example: "DYNAMIC" "Report-To": schema: type: "string" example: "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=kzna5v%2FIi6v%2Bvp4O%2Brd9ebQ9A7REBcooj5TqqsOvveesmycrXGQm3ZG%2BlJsf2sVF5lRqGjaEkJyyHqH90FIO0c375UiWcZS7TtwDF%2BUSBQVYpJOD%2FFrnGD4lDpCfupH7eqjgOwSlFNMy5QY%2B\"}],\"group\":\"cf-nel\",\"max_age\":604800}" "NEL": schema: type: "string" example: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}' "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "90a10ac90aece86a-KHI" "server-timing": schema: type: "string" example: 'cfL4;desc="?proto=TCP&rtt=28822&min_rtt=27831&rtt_var=8443&sent=34&recv=35&lost=0&retrans=0&sent_bytes=3747&recv_bytes=1572&delivery_rate=99616&cwnd=252&unsent_bytes=0&cid=f4525ef55750a521&ts=30353&x=0"' description: "400" content: "application/json": schema: type: "object" properties: "details": type: "object" properties: "event": type: "string" "error": type: "string" format: "style" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 30 Jan 2025 11:15:29 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "222" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "cf-cache-status": schema: type: "string" example: "DYNAMIC" "Report-To": schema: type: "string" example: "{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=sCsHwy4GDnHw9aqS24IaCV8rgA49Wy43wnJrlF3gKpTXUGlLi3MPoEbfeomh0YPWX413G2jEUeEBC82otLrdIyz3BpoRXnG51uDKsGolIEqvfOl1m7GP5TKmeUo0GNNUalp0e863d6Rv9M6K\"}],\"group\":\"cf-nel\",\"max_age\":604800}" "NEL": schema: type: "string" example: '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}' "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "90a10b5be96be86a-KHI" "server-timing": schema: type: "string" example: 'cfL4;desc="?proto=TCP&rtt=29164&min_rtt=27831&rtt_var=7016&sent=58&recv=59&lost=0&retrans=0&sent_bytes=4872&recv_bytes=2063&delivery_rate=99616&cwnd=253&unsent_bytes=0&cid=f4525ef55750a521&ts=53759&x=0"' description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/Error" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/Error" requestBody: content: "application/json": schema: type: "object" properties: "event": type: "string" "identifier": type: "string" required: true x-speakeasy-group: "webhooks" x-speakeasy-name-override: "test" "/client/plans/v1": post: summary: "Create Plan" responses: "200": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 08:05:43 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2b8fdac8121e3-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "request_id": type: "string" "plan_id": type: "string" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 07:58:09 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "35" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2ade8d9ed21e3-KHI" description: "400" content: "application/json": schema: type: "object" properties: "error": type: "string" format: "style" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 07:54:16 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "200" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2a8341a6921e3-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "500": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 07:56:41 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "73" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2abc19e6c21e3-KHI" description: "500" content: "application/json": schema: type: "object" properties: "error": type: "string" format: "style" "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "amount": type: "string" format: "color" "currency": type: "string" "interval": type: "string" "type": type: "string" "interval_count": type: "integer" "product": type: "string" "active": type: "boolean" required: true x-speakeasy-group: "plans" x-speakeasy-name-override: "create" "/client/plans/v1/search": get: summary: "Search Plans" parameters: - name: "plan_ids" in: "query" required: false description: "Filter for specific Plan IDs" schema: type: "string" - name: "intervals" in: "query" required: false description: "Filter for specific intervals" schema: type: "string" - name: "products" in: "query" required: false description: "Filter for specific products" schema: type: "string" - name: "currencies" in: "query" required: false description: "Filter for specific currencies" example: "PKR" schema: type: "string" - name: "limit" in: "query" required: false description: "Limit search results to a value" schema: type: "string" - name: "page" in: "query" required: false description: "Paginate search results" schema: type: "string" - name: "sort_by" in: "query" required: false description: "Sort by specifies the field use to sort data e.g. `created_at`" schema: type: "string" - name: "direction" in: "query" required: false description: "Direction specifies the data sort order either ASC or DESC" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 08:37:26 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2e77968ef21e6-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "plans": type: "array" items: type: "object" properties: "token": type: "string" "merchant_api_key": type: "string" "name": type: "string" "amount": type: "string" format: "color" "currency": type: "string" "interval_count": type: "integer" "interval": type: "string" "product": type: "string" "type": type: "string" "trial_period_days": type: "integer" "description": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "active": type: "boolean" "archived": type: "boolean" "number_of_billing_cycles": type: "integer" "apply_amount_change_on_existing_subscriptions": type: "boolean" "price_money": type: "object" properties: "currency": type: "string" "amount": type: "string" format: "color" "count": type: "integer" "sort_by": type: "string" "direction": type: "string" "status": $ref: "#/components/schemas/Status" "400": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 08:39:10 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "52" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2ea011f6e21e6-KHI" description: "400" content: "application/json": schema: type: "object" properties: "error": type: "string" format: "style" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 08:38:15 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "200" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e2e8ab8af621e6-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "plans" x-speakeasy-name-override: "search" "/client/subscriptions/v1/search": get: summary: "Search Subscriptions" parameters: - name: "tokens" in: "query" required: false description: "Filter by subscription IDs" schema: type: "string" - name: "plan_ids" in: "query" required: false description: "Filter by plan IDs" schema: type: "string" - name: "user_ids" in: "query" required: false description: "Filter by User IDs" schema: type: "string" - name: "statuses" in: "query" required: false description: "Filter by statuses" schema: type: "string" - name: "limit" in: "query" required: false description: "Limit search results to a value" schema: type: "string" - name: "page" in: "query" required: false description: "Paginate search results" schema: type: "string" - name: "sort_by" in: "query" required: false description: "Sort by specifies the field use to sort data e.g. `created_at`" schema: type: "string" - name: "direction" in: "query" required: false description: "Direction specifies the data sort order either ASC or DESC" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 10:08:58 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e36d84c84c21f5-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "subscriptions": type: "array" items: type: "object" properties: "token": type: "string" "plan_id": type: "string" "user_id": type: "string" "instrument_id": type: "string" "status": type: "string" "billing_cycle_anchor": type: "string" format: "date-time" "price_amount": type: "string" format: "utc-millisec" "price_currency": type: "string" "balance": type: "string" format: "utc-millisec" "start_date": type: "string" format: "date-time" "trial_start_date": type: "string" format: "date-time" "trial_end_date": type: "string" format: "date-time" "cancel_at_period_end": type: "boolean" "canceled_at": type: "string" format: "date-time" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "plan": type: "object" properties: "token": type: "string" "merchant_api_key": type: "string" "name": type: "string" "amount": type: "string" format: "utc-millisec" "currency": type: "string" "interval_count": type: "integer" "interval": type: "string" "product": type: "string" "type": type: "string" "trial_period_days": type: "integer" "description": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "active": type: "boolean" "archived": type: "boolean" "number_of_billing_cycles": type: "integer" "apply_amount_change_on_existing_subscriptions": type: "boolean" "price_money": type: "object" properties: "currency": type: "string" "amount": type: "string" format: "utc-millisec" "current_period_start_date": type: "string" format: "date-time" "current_period_end_date": type: "string" format: "date-time" "never_expires": type: "boolean" "number_of_billing_cycles": type: "integer" "merchant_api_key": type: "string" "price_money": type: "object" properties: "currency": type: "string" "amount": type: "string" format: "utc-millisec" "count": type: "string" format: "utc-millisec" "direction": type: "string" "sort_by": type: "string" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 10:09:24 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "200" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e36e2e7cc521f5-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "subscriptions" x-speakeasy-name-override: "search" "/client/transactions/v1/search": get: summary: "Search Transactions" parameters: - name: "tokens" in: "query" required: false description: "Filter by transaction IDs" schema: type: "string" - name: "states" in: "query" required: false description: "Filter by transaction states " schema: type: "string" - name: "currencies" in: "query" required: false description: "Filter by currencies" schema: type: "string" - name: "instrument_ids" in: "query" required: false description: "Filter by instrument IDs" schema: type: "string" - name: "subscription_ids" in: "query" required: false description: "Filter by subscription IDs" schema: type: "string" - name: "user_ids" in: "query" required: false description: "Filter by User IDs" schema: type: "string" - name: "limit" in: "query" required: false description: "Limit search results" schema: type: "string" - name: "page" in: "query" required: false description: "Paginate search results" schema: type: "string" - name: "sort_by" in: "query" required: false description: "Sort by specifies the field use to sort data e.g. `created_at`" schema: type: "string" - name: "direction" in: "query" required: false description: "Direction specifies the data sort order either ASC or DESC" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 11:56:18 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e40ac83df921f5-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "transactions": type: "array" items: type: "object" properties: "token": type: "string" "charge_at": type: "string" format: "date-time" "charged": type: "string" format: "date-time" "status": type: "string" "amount": type: "string" format: "utc-millisec" "currency": type: "string" "instrument_id": type: "string" "subscription_id": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "failures": type: "array" items: {} "subscription": nullable: true "merchant_api_key": type: "string" "user_id": type: "string" "transaction_type": type: "string" "proration": type: "boolean" "tracker": type: "string" "price_money": type: "object" properties: "currency": type: "string" "amount": type: "string" format: "utc-millisec" "count": type: "integer" "direction": type: "string" "sort_by": type: "string" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Fri, 29 Sep 2023 11:57:09 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "200" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE, PATCH" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80e40c049fea21f5-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "clientTransactions" x-speakeasy-name-override: "search" "/invoice/quick-links/v2": post: summary: "Create" responses: "200": description: 200 - Manual Workflow requestBody: content: "application/json": schema: type: "object" properties: "amount": type: "integer" "currency": type: "string" "note": type: "string" "workflow": type: "string" required: true x-speakeasy-group: "invoices" x-speakeasy-name-override: "createQuickLink" "/invoice/quick-links/v1": post: summary: "Create Quick Link" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 11:26:27 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dba1a89b57c904-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "id": type: "string" "merchant_id": type: "string" "number": type: "string" format: "utc-millisec" "status": type: "string" "note": type: "string" "metadata": type: "array" items: type: "object" properties: "id": type: "string" "quick_link_id": type: "string" "recipient_view_url": type: "string" format: "uri" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "payment": nullable: true "recipients": nullable: true "total": type: "integer" "currency": type: "string" "workflow": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 11:29:26 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "111" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dba60c8b5dc904-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/Error" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/Error" "417": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 11:29:07 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "78" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dba5968b77c904-KHI" description: "417" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "amount": type: "integer" "currency": type: "string" "note": type: "string" "workflow": type: "string" required: true x-speakeasy-group: "quickLinks" x-speakeasy-name-override: "create" get: summary: "Search Quick Links" parameters: - name: "page" in: "query" required: false description: "The page to search for. Page serves as an offset counter starting with 1" example: "1" schema: type: "integer" - name: "limit" in: "query" required: false description: "How many results to return per page. A limit of 10 will return 10 Quick Links per page" example: "10" schema: type: "integer" - name: "workflow" in: "query" required: false description: "One of EMAIL or MANUAL" example: "MANUAL" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 12:53:48 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dc219fdf5a0048-KHI" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "count": type: "integer" "list": type: "array" items: type: "object" properties: "id": type: "string" "merchant_id": type: "string" "number": type: "string" format: "utc-millisec" "status": type: "string" "note": type: "string" "metadata": type: "array" items: type: "object" properties: "id": type: "string" "quick_link_id": type: "string" "recipient_view_url": type: "string" format: "uri" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "payment": type: "array" items: {} "recipients": type: "array" items: {} "total": type: "integer" "currency": type: "string" "workflow": type: "string" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 12:53:28 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "70" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dc21216fef0048-KHI" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" "417": headers: "Date": schema: type: "string" example: "Thu, 28 Sep 2023 12:54:11 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "87" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, DELETE, OPTIONS, PUT" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "80dc22327af30048-KHI" description: "417" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "quickLinks" x-speakeasy-name-override: "search" "/user/v2": post: summary: "Create Safepay Shopper" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 08:32:37 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab3ffc23b19d1d8-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "contacts": type: "array" items: type: "object" properties: "token": type: "string" "user": type: "string" "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "utc-millisec" "is_default": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "nanos": type: "integer" "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "phone" "avatar": type: "string" "suspended": type: "integer" "suspend_reason": type: "string" "verified": type: "integer" "verification": type: "object" properties: "user_id": type: "string" "code": type: "string" format: "color" "verification_type": type: "integer" "expires_at": type: "string" format: "date-time" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "409": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 08:31:59 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Content-Length": schema: type: "integer" example: "131" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab3fed5ef34d1d8-MCT" description: "409" content: "application/json": schema: type: "object" properties: "code": type: "string" "message": type: "string" "status": $ref: "#/components/schemas/Status" requestBody: content: "application/json": schema: type: "object" properties: "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "utc-millisec" "password": type: "string" required: true x-speakeasy-group: "shoppers" x-speakeasy-name-override: "createSafepay" get: summary: "Find Safepay Shopper" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:22:45 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab4493afc67d1f4-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "token": type: "string" "contacts": type: "array" items: type: "object" properties: "token": type: "string" "user": type: "string" "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "utc-millisec" "is_default": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "phone" "avatar": type: "string" "suspended": type: "integer" "suspend_reason": type: "string" "verified": type: "integer" "verification": type: "object" properties: "user_id": type: "string" "code": type: "string" format: "color" "verification_type": type: "integer" "expires_at": type: "string" format: "date-time" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:17:09 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Content-Length": schema: type: "integer" example: "70" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab44106ae4dd1f4-MCT" description: "401" content: "application/json": schema: type: "object" properties: "code": type: "string" "message": type: "string" "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "users" x-speakeasy-name-override: "findSafepayShopper" "/user/v2/exists": get: summary: "Safepay Shopper Exists" parameters: - name: "email" in: "query" required: false example: "hzaidi@getsafepay.com" schema: type: "string" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 20 Aug 2024 07:33:43 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8b60b2631942b744-BRU" "Content-Encoding": schema: type: "string" example: "gzip" description: "200 - Exists" content: "application/json": schema: type: "object" properties: "data": type: "object" properties: "exists": type: "boolean" "is_local": type: "boolean" "has_password": type: "boolean" "phone": type: "string" "email": type: "string" format: "email" "400": headers: "Date": schema: type: "string" example: "Tue, 20 Aug 2024 07:35:01 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=UTF-8" "Content-Length": schema: type: "integer" example: "65" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "Vary": schema: type: "string" example: "Origin" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8b60b44bcb05b744-BRU" description: "400" content: "application/json": schema: type: "object" properties: "code": type: "string" "message": type: "string" format: "style" x-speakeasy-group: "users" x-speakeasy-name-override: "exists" "/user/wallets/v1": get: summary: "List Payment Methods" responses: "200": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:41:53 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Transfer-Encoding": schema: type: "string" example: "chunked" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab4653e286dde53-MCT" "Content-Encoding": schema: type: "string" example: "gzip" description: "200" content: "application/json": schema: type: "object" properties: "data": type: "array" items: type: "object" properties: "token": type: "string" "user": type: "string" "payment_method_token": type: "string" "deduplication_key": type: "string" "intent": type: "string" "last_4": type: "string" format: "utc-millisec" "instrument_type": type: "string" "expiry_month": type: "string" format: "utc-millisec" "expiry_year": type: "string" format: "utc-millisec" "contact": type: "object" properties: "token": type: "string" "user": type: "string" "first_name": type: "string" "last_name": type: "string" "email": type: "string" format: "email" "phone": type: "string" format: "phone" "is_default": type: "boolean" "created_at": type: "object" properties: "seconds": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "address": $ref: "#/components/schemas/Address" "cybersource": type: "object" properties: "token": type: "string" "payment_method": type: "string" "scheme": type: "integer" "bin": type: "string" format: "color" "last_four": type: "string" format: "utc-millisec" "expiry_month": type: "string" format: "utc-millisec" "expiry_year": type: "string" format: "utc-millisec" "created_at": type: "object" properties: "seconds": type: "integer" "updated_at": type: "object" properties: "seconds": type: "integer" "created_at": type: "string" format: "date-time" "updated_at": type: "string" format: "date-time" "status": $ref: "#/components/schemas/Status" "401": headers: "Date": schema: type: "string" example: "Tue, 30 Jul 2024 09:42:10 GMT" "Content-Type": schema: type: "string" example: "application/json; charset=utf-8" "Content-Length": schema: type: "integer" example: "174" "Connection": schema: type: "string" example: "keep-alive" "Access-Control-Allow-Headers": schema: type: "string" example: "Origin, Content-Type, Authorization" "Access-Control-Allow-Methods": schema: type: "string" example: "GET, POST, OPTIONS, PUT, DELETE" "Access-Control-Allow-Origin": schema: type: "string" example: "*" "CF-Cache-Status": schema: type: "string" example: "DYNAMIC" "Server": schema: type: "string" example: "cloudflare" "CF-RAY": schema: type: "integer" example: "8ab465a9e90bde53-MCT" description: "401" content: "application/json": schema: type: "object" properties: "data": nullable: true "status": $ref: "#/components/schemas/Status" x-speakeasy-group: "userWallets" x-speakeasy-name-override: "listPaymentMethods" x-speakeasy-retries: { "strategy": "backoff", "backoff": { "initialInterval": 500, "maxInterval": 60000, "maxElapsedTime": 3600000, "exponent": 1.5, }, "statusCodes": ["5XX", 5XX], "retryConnectionErrors": true, } components: schemas: Status: type: object properties: errors: type: array items: {} message: type: string Error: type: object properties: code: type: string message: type: string DateTimeObj: type: object properties: seconds: type: integer nanos: type: integer Money: type: object properties: currency: type: string amount: oneOf: - type: string - type: integer ApiKeyData: type: object properties: token: type: string client_id: type: string webhook_secret: type: string created_at: type: string format: date-time updated_at: type: string format: date-time SessionToken: type: object properties: session: type: string token: type: string QuickLinkRequest: type: object properties: amount: type: integer currency: type: string note: type: string workflow: type: string Metadata: type: object properties: id: type: string quick_link_id: type: string recipient_view_url: type: string format: uri created_at: type: string format: date-time updated_at: type: string format: date-time Verification: type: object properties: user_id: type: string code: type: string verification_type: type: integer expires_at: type: string format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time DateTimeSeconds: type: object properties: seconds: type: integer Address: type: object properties: token: type: string owner: type: string street1: type: string city: type: string country: type: string is_default: type: boolean created_at: $ref: "#/components/schemas/DateTimeSeconds" updated_at: $ref: "#/components/schemas/DateTimeSeconds"