GatewayPay Documentation
  1. Account
GatewayPay Documentation
  • GatewayPay API Documentation
  • Authentication
  • Callbacks
  • Testing
  • Domains and IP Addresses
  • Account
    • Get Account profile details
      GET
    • Get Account balances
      GET
    • Get Account payment options
      GET
  • H2H flow
    • Status List
    • Create Payment Invoice
      POST
    • Send Card Data to the Gateway
      POST
    • Full List of Payment Services
      GET
    • Get Service Data by ID
      GET
    • Check Status of Payment Invoice by ID
      GET
    • Get list of Payment Invoices
      GET
  • Refunds
    • Refund
      POST
  • Cards Whitelist API
    • JSON
      POST
    • CSV
      POST
  • APM - Deposits
    • Bank Transfers - Turkey
      POST
  • APM - Payouts
    • Bank Transfers - Turkey (Invoice Initiation)
      POST
    • Bank Transfers - Turkey (Invoice processing)
      POST
  1. Account

Get Account payment options

GET
/account/payment-options

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params
Host
string 
required
Example:
{{BASE_API_URL}}

Responses

🟢200OK
application/json
Body
data
object 
required
type
string 
required
id
string 
required
attributes
object 
required
links
object 
required
Example
{
    "data": {
        "type": "account",
        "id": "coma_xfepg37GYEWC8K6f",
        "attributes": {
            "payment_options": {
                "descriptor_template": null,
                "description_template": null,
                "disabled_services": [],
                "methods": [
                    {
                        "code": "upi_qr",
                        "hide": false,
                        "disabled": false,
                        "position": 0
                    },
                    {
                        "code": "test",
                        "hide": false,
                        "disabled": false,
                        "position": 1
                    }
                ],
                "disable_new_services": false,
                "reverse_fee": false,
                "fee_strategy": "internal",
                "invoice_lifetime": 60,
                "forbid_public_creation": false,
                "public_fee": false,
                "expose_internal_data": true,
                "expose_internal_data_config": {
                    "original_data": [
                        "original_resolution_message",
                        "original_resolution"
                    ]
                },
                "bypass_hpp": true,
                "force_commerce_return_url": false,
                "send_operation_context_on_return": false,
                "refund_fee": false,
                "allow_overwrite_descriptor": false,
                "return_url": null,
                "return_urls": {
                    "fail": null,
                    "pending": null,
                    "success": null
                },
                "return_fee_on_refund": false,
                "return_fee_on_chargeback": false,
                "async_ledger": true,
                "invoice_convertation": false,
                "allow_partially": false,
                "delayed_action_delay": 60,
                "delayed_action": "capture",
                "addons": []
            }
        },
        "links": {
            "self": "/api/account/payment-options"
        }
    }
}
Modified at 2024-10-09 12:46:46
Previous
Get Account balances
Next
H2H flow
Built with