Setup
Contact Ecommpay to obtain sandbox credentials for your region. Then, in the Gr4vy dashboard, add your Ecommpay connection using your Project ID and Secret key.Connector configuration
After setting up your Ecommpay connector in the dashboard, configure how transactions are routed to it. Choose one of the following options:- Using Flow - Configure Ecommpay as the target connector in Flow to automatically route card transactions to this connector
- Using the API - Explicitly set the
payment_service_idparameter to the Ecommpay connector ID when creating transactions. This overrides any Flow routing rules.
Tokenization callbacks
Your Ecommpay contact must enable tokenization for your project. After it is enabled, set up a dedicated tokenization callback. Gr4vy automatically handles Ecommpay’s transaction webhooks, but tokenization results use a separate callback. To configure the tokenization callback:- In the Ecommpay dashboard, go to Settings -> Callbacks.
- Create a new callback using the synchronization URL from your Ecommpay connector settings in the Gr4vy dashboard.
- Set the callback result type to “tokenize”.
Credentials
When setting up Ecommpay in the dashboard, configure the following credentials.- Project ID - The numeric project identifier from your Ecommpay dashboard.
- Secret key - The secret key from your Ecommpay dashboard.
Features
Ecommpay supports the following features:- Delayed capture - Authorize a payment and capture it at a later time
- Partial capture - Capture a portion of the authorized amount
- Partial refunds - Refund a portion of the captured amount
- Refunds - Refund a captured payment
- Void - Cancel an authorized transaction before capture
- Zero auth - Verify a card without charging it
- Digital wallets - Support for Apple Pay, Google Pay, and other wallet integrations
- Airline data - Support for airline addendum data in transactions
- Payment method tokenization - Tokenize payment methods through Ecommpay
- Deep linking - Use deep links for supported flows
- Transaction sync - Synchronize transaction status with Ecommpay
- 3-D Secure - Pass-through 3DS authentication
- Webhooks required - Webhooks are required for status updates
Supported countries
Ecommpay supports transactions from buyers in the following countries:| Code | Country code | Country code | Country code | Country code | Country code | Country code | Country code |
|---|---|---|---|---|---|---|---|
AD | AE | AF | AG | AI | AL | AM | AO |
AQ | AR | AS | AT | AU | AW | AX | AZ |
BA | BB | BD | BE | BF | BG | BH | BI |
BJ | BL | BM | BN | BO | BQ | BR | BS |
BT | BV | BW | BY | BZ | CA | CC | CD |
CF | CG | CH | CI | CK | CL | CM | CN |
CO | CR | CU | CV | CW | CX | CY | CZ |
DE | DJ | DK | DM | DO | DZ | EC | EE |
EG | EH | ER | ES | ET | FI | FJ | FK |
FM | FO | FR | GA | GB | GD | GE | GF |
GG | GH | GI | GL | GM | GN | GP | GQ |
GR | GS | GT | GU | GW | GY | HK | HM |
HN | HR | HT | HU | ID | IE | IL | IM |
IN | IO | IQ | IR | IS | IT | JE | JM |
JO | JP | KE | KG | KH | KI | KM | KN |
KP | KR | KW | KY | KZ | LA | LB | LC |
LI | LK | LR | LS | LT | LU | LV | LY |
MA | MC | MD | ME | MF | MG | MH | MK |
ML | MM | MN | MO | MP | MQ | MR | MS |
MT | MU | MV | MW | MX | MY | MZ | NA |
NC | NE | NF | NG | NI | NL | NO | NP |
NR | NU | NZ | OM | PA | PE | PF | PG |
PH | PK | PL | PM | PN | PR | PS | PT |
PW | PY | QA | RE | RO | RS | RU | RW |
SA | SB | SC | SD | SE | SG | SH | SI |
SJ | SK | SL | SM | SN | SO | SR | SS |
ST | SV | SX | SY | SZ | TC | TD | TF |
TG | TH | TJ | TK | TL | TM | TN | TO |
TR | TT | TV | TW | TZ | UA | UG | UM |
US | UY | UZ | VA | VC | VE | VG | VI |
VN | VU | WF | WS | XK | YE | YT | ZA |
ZM | ZW |
Supported currencies
Ecommpay supports processing payments in the following currencies:| Currency code | Currency code | Currency code | Currency code | Currency code | Currency code | Currency code | Currency code | Currency code | Currency code |
|---|---|---|---|---|---|---|---|---|---|
AED | AFN | ALL | AMD | AOA | ARS | AUD | AWG | AZN | BAM |
BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BOV | BRL |
BSD | BTN | BWP | BYN | BZD | CAD | CDF | CHE | CHF | CHW |
CLF | CLP | CNY | COP | COU | CRC | CUP | CVE | CZK | DJF |
DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP |
GEL | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HTG |
HUF | IDR | ILS | INR | IQD | IRR | ISK | JMD | JOD | JPY |
KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK |
LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK |
MNT | MOP | MRU | MUR | MVR | MWK | MXN | MXV | MYR | MZN |
NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK |
PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR |
SBD | SCR | SDG | SEK | SGD | SHP | SLE | SOS | SRD | SSP |
STN | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY |
TTD | TWD | TZS | UAH | UGX | USD | USN | UYI | UYU | UYW |
UZS | VED | VES | VND | VUV | WST | XAF | XCD | XCG | XOF |
XPF | YER | ZAR | ZMW | ZWG |
Limitations
The following features are not supported by this connector:- 3-D Secure hosted - Hosted 3DS flows are not supported
- Create session - Session creation is not supported
- Create token - Token creation is not supported
- Network tokens - Network tokenization is not supported
- Open loop - Open-loop card processing is not supported
- Over capture - Capturing more than the authorized amount is not supported
- Partial authorization - Partial authorization is not supported
- Asynchronous processing - Ecommpay acknowledges requests immediately and completes transactions asynchronously. Gr4vy polls for status updates after the initial call, sending up to three checks at roughly the 1, 3, and 5 second marks. Webhooks are monitored as a fail-safe. One transaction can appear as multiple API requests plus a webhook event in the dashboard.
- CVV required - A CVV is required for all card payments, except for stored credential follow-up payments and merchant-initiated transactions where the initial payment included a CVV.
- Closed loop - Ecommpay can only process card tokens generated through Ecommpay.
Integration
To accept card payments with Ecommpay, use one of Gr4vy’s client-side integration methods to securely collect card details. Due to PCI compliance requirements, card data should never be sent directly to your servers. You can integrate using:- Embed - A pre-built, customizable payment form that handles the complete payment flow
- Secure Fields - Embed card input fields for building custom payment forms while maintaining PCI compliance
- Mobile SDKs - Native SDKs for iOS, Android, React Native, and other platforms
payment_service_id parameter.
Required fields
Ecommpay requires the following fields in thebilling_details of a card
payment:
- Email address - Required for checkout.
- Phone number - Required for checkout.