GatewayPay Documentation
  1. H2H flow
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. H2H flow

Send Card Data to the Gateway

POST
/payment/sale
The request should be sent to {{CARDGATE_URL}} which you will receive from the manager.
For authorization, use the token from the response to the invoice creation request, flow_data object → metadata

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Host
string 
required
Example:
{{CARDGATE_URL}}
Body Params application/json
data
object 
required
type
string 
required
attributes
object 
required
Example
{
  "data": {
    "type": "sale-operation",
    "attributes": {
      "card_number": "5519283812030000",
      "card_holder": "Jack Smith",
      "cvv": "123",
      "exp_month": "04",
      "exp_year": "30",
      "browser_info": {
        "browser_color_depth": "24",
        "browser_ip": "123.123.12.1",
        "browser_java_enabled": false,
        "browser_language": "en-US",
        "browser_screen_height": "1200",
        "browser_screen_width": "1920",
        "browser_tz": "-780",
        "browser_user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_3_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.3.1 Mobile/15E148 Safari/604.1",
        "browser_accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
      }
    }
  }
}

Responses

🟢2013DS flow
application/json

(for 3DS Flow) Client Redirect to ACS

The auth_payload object contains 3DS data for the Card Gate request response.
You should send to action URL the form's parameters params by method method. Meanwhile, these parameters and their names may change depending on the acquirer standards.
Body
status
string 
required
auth_mode
string 
required
auth_payload
object 
required
action
string 
required
method
string 
required
params
object 
required
embedded_acs
boolean 
required
Examples
{
    "status": "process_pending",
    "auth_mode": "3ds",
    "auth_payload": {
        "action": "https://checkout.example.com/form/cgi_irx0G82A8VBlkt5M",
        "params": [],
        "method": "GET",
        "embedded_acs": false
    }
}
🟢201non-3DS flow
Modified at 2024-10-10 14:23:13
Previous
Create Payment Invoice
Next
Full List of Payment Services
Built with