ASTRO_PAY_QR

AstroPayQrPayload

Payment Method Identifier

ASTRO_PAY_QR

Description

This method allows you to accept AstroPay QR payments. Customers scan a dynamically generated QR code using the AstroPay mobile app to complete the payment instantly.

Currency Support

Supports currencies available on the AstroPay platform. Refer to your merchant configuration for the specific currencies enabled on your account.

✅ Required Request Fields

Top-Level Fields

Field	Type	Description
`callbackUrl`	String	URL to receive transaction status updates
`successRedirectUrl`	String	URL to redirect the customer after successful payment
`failureRedirectUrl`	String	URL to redirect the customer after failed payment

Billing Details (ApmBillingDetails)

Field	Type	Description
`firstName`	String	Customer's first name
`lastName`	String	Customer's last name
`address1`	String	First line of the billing address
`city`	String	City of the billing address
`country`	String	Country code in ISO Alpha-2 format
`postalCode`	String	Postal/ZIP code
`phone`	String	Customer's phone number
`email`	String	Customer's email address

Device Information (Device)

Field	Type	Description
`ip`	String	Customer's IP address

Payload Structure

{
  "paymentMethod": "ASTRO_PAY_QR",
  "paymentType": "E_WALLET"
}

Fields

Field	Type	Required	Description
`paymentMethod`	Enum	Yes	Must be `"ASTRO_PAY_QR"`
`paymentType`	Enum	Yes	Must be `"E_WALLET"`

No additional fields are required. All necessary user interaction is handled within the AstroPay mobile app.

Expected `apmResponseData` (AstroPayQrResponseData)

{
  "paymentMethod": "ASTRO_PAY_QR",
  "paymentType": "E_WALLET",
  "redirectUrl": null,
  "iframeUrl": null,
  "providerTransactionId": "payment-code-external-id",
  "actionType": "QR",
  "qrData": "data:image/png;base64,iVBORw0KGgoAAAA...CYII=",
  "qrDeepLink": null
}

Response Fields

Field	Type	Description
`paymentMethod`	Enum	`"ASTRO_PAY_QR"`
`paymentType`	Enum	`"E_WALLET"`
`redirectUrl`	String (nullable)	Always `null` for `ASTRO_PAY_QR`
`iframeUrl`	String (nullable)	Always `null` for `ASTRO_PAY_QR`
`providerTransactionId`	String (nullable)	Transaction ID from AstroPay
`actionType`	String	Always `"QR"`
`qrData`	String (nullable)	QR code image encoded as a base64 data URI (`data:image/png;base64,...`). Can be used directly in an `<img>` tag: `<img src="$qrData" width="200" height="200" alt="QR Code">`
`qrDeepLink`	String (nullable)	Deep link URL to open the AstroPay app directly on mobile devices. May be `null` if not provided by the payment provider.

Deep link URL to open the AstroPay app directly on mobile devices. May be `null` if not provided by the payment provider.

Updated about 6 hours ago