Forked from raymond-hitpay/hitpay-payment-request-response.schema.json
Created
November 2, 2025 17:09
-
-
Save Yobb17/de7efdc5227e7fa7567a480d70a5b2e8 to your computer and use it in GitHub Desktop.
HitPay Payment Request API - JSON Schema (Response Format)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "$schema": "http://json-schema.org/draft-07/schema#", | |
| "title": "HitPayPaymentRequestResponse", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "string" | |
| }, | |
| "name": { "type": "string" }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "phone": { | |
| "type": "string" | |
| }, | |
| "amount": { | |
| "type": "string", | |
| "pattern": "^[0-9]+(\\.[0-9]{2})?$" | |
| }, | |
| "currency": { | |
| "type": "string", | |
| "pattern": "^[A-Z]{3}$" | |
| }, | |
| "is_currency_editable": { | |
| "type": "boolean" | |
| }, | |
| "status": { | |
| "type": "string" | |
| }, | |
| "purpose": { | |
| "type": "string" | |
| }, | |
| "reference_number": { | |
| "type": "string" | |
| }, | |
| "payment_methods": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "card", | |
| "card_present", | |
| "card_adyen", | |
| "card_present_adyen", | |
| "paynow", | |
| "paynow_online", | |
| "wechat", | |
| "grabpay", | |
| "shopeepay", | |
| "shopee_pay", | |
| "fpx", | |
| "paylah", | |
| "paywave", | |
| "touchngo", | |
| "duitnow_qr", | |
| "alipay", | |
| "boost", | |
| "atome", | |
| "triple_a_pay", | |
| "qrph_netbank", | |
| "ifpay_qris" | |
| ] | |
| } | |
| }, | |
| "url": { | |
| "type": "string" | |
| }, | |
| "redirect_url": { | |
| "type": "string" | |
| }, | |
| "webhook": { | |
| "type": "string" | |
| }, | |
| "send_sms": { | |
| "type": "boolean" | |
| }, | |
| "send_email": { | |
| "type": "boolean" | |
| }, | |
| "sms_status": { | |
| "type": "string" | |
| }, | |
| "email_status": { | |
| "type": "string" | |
| }, | |
| "allow_repeated_payments": { | |
| "type": "boolean" | |
| }, | |
| "expiry_date": { | |
| "type": "string" | |
| }, | |
| "address": { | |
| "type": "object", | |
| "properties": { | |
| "line1": { "type": "string" }, | |
| "line2": { "type": "string" }, | |
| "city": { "type": "string" }, | |
| "state": { "type": "string" }, | |
| "country": { "type": "string" }, | |
| "postal_code": { "type": "string" } | |
| }, | |
| "required": ["line1", "city", "country", "postal_code"] | |
| }, | |
| "line_items": { | |
| "type": ["array", "null"] | |
| }, | |
| "executor_id": { | |
| "type": "integer" | |
| }, | |
| "created_at": { | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "type": "string" | |
| }, | |
| "staff_id": { | |
| "type": "string" | |
| }, | |
| "business_location_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "id", "amount", "currency", "status", "reference_number", | |
| "url", "created_at", "updated_at" | |
| ], | |
| "additionalProperties": false | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment