Card iFrame API
Ask AI
Endpoint contract
Create a card iframe session. GLODIPAY returns a signed URL for the hosted card form, and the merchant embeds that URL in an <iframe>.
POST /v2/card/iframeapplication/jsonSignature required
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
merchantId | String(1,50) | M | Merchant ID. |
orderRef | String(1,250) | M | Unique transaction reference. |
amount | Float | M | Invoice amount. |
currency | String(3) | M | ISO 4217 currency code. |
cancelUrl | String(1,300) | M | HTTPS redirect URL on cancellation. |
callbackUrl | String(1,300) | M | HTTPS redirect URL after payment success. |
notificationUrl | String(1,300) | M | HTTPS webhook endpoint. |
errorUrl | String(1,300) | M | HTTPS redirect URL on payment error. |
orderDescription | String(max:3000) | M | Short order description. |
metadata | JSON | O | Attached key-value data. |
transactionDocuments | JSON | O | Supporting documents. |
paymentMethod | String | M | Must be card. |
feeBySeller | Number(0-100) | O | Seller fee percentage. |
billingEmail | String(max:255) | O | Buyer email. |
billingCountry | String | O | ISO 3166-1 alpha-2 country code. |
billingFirstName | String(max:255) | O | Billing first name. |
billingLastName | String(max:255) | O | Billing last name. |
billingStreet1 | String(max:255) | O | Billing address line 1. |
billingStreet2 | String(max:255) | O | Billing address line 2. |
billingCity | String(max:255) | O | Billing city. |
billingState | String(2,255) | O | Billing state. |
billingPostalCode | String(max:25) | O | Postal / ZIP code. |
billingPhoneCountryCode | String(max:10) | O | Phone country code. |
billingPhoneNumber | String(max:20) | O | Phone number. |
customerIp | String | O | Customer IP address. |
websiteUrl | String(max:300) | O | Merchant website URL. |
brandName | String(1,255) | O | Override the brand name on the card form. |
colorMode | String(1,255) | O | Up to 3 colors separated by ---. |
logoSource | String(1,255) | O | Override the logo on the card form. |
expiresAt | String | O | ISO 8601 session expiry. |
signature | String(max:750) | M | RSA-MD5 signature. |
Response and embed flow
On success, the response contains status, transactionId, url, and message. Embed the returned URL into your page:
<iframe
src="{url}"
width="100%"
height="600"
frameborder="0"
scrolling="no"
allowtransparency="true">
</iframe>The signed URL is temporary and tied to the checkout session. GLODIPAY sends the final result through notificationUrl and then redirects the buyer to callbackUrl or errorUrl.
Source
This page is derived from iFrame Card API.