PagoEfectivo Payment Request

typestringrequired

Product type. Must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD

amountnumber<double>required

Payment amount with two decimal places.

Possible values: >= 0.01

Example: 10

currencystringrequired

Three-letter ISO 4217 currency code.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

Example: USD

redirect objectrequired

success_urlstring<uri>required

URL used after successful payment authorization.

Example: https://ok.com

failure_urlstring<uri>required

URL used after failed or cancelled payment authorization.

Example: https://nok.com

auth_urlstring<uri>

URL to which the customer is redirected for authorization.

Example: https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet

notification_urlstring<uri>required

Notification URL contacted after payment authorization has completed successfully.

The {payment_id} placeholder in the URL is replaced with the actual payment ID.

Example: https://notification.com/{payment_id}

customer objectrequired

idstringrequired

Unique customer identifier provided by the merchant.

Example: test_dev

restrictions object

Payment restrictions used to initiate a payment for the option selected by the customer during merchant checkout.

payment_instrumentstringrequired

Payment instrument selected at merchant checkout.

Possible values: [paysafecard, pagoefectivo]

Example: pagoefectivo

payment_instrument_subtypestring

Optional payment-instrument subtype.

Error number 2039 is returned when the supplied value is invalid.

TODO: Confirm the supported PagoEfectivo subtype values from the source integration documentation.

submerchant_idstring

Sub-merchant identifier, also known as the reporting criterion.

The value can contain up to eight alphanumeric characters. An unregistered value can cause payment initiation to fail.

Possible values: <= 8 characters, Value must match regular expression ^[A-Za-z0-9]+$

Example: 1

customer_data_takeover object

Customer data used to prefill information during payment creation and improve the customer flow.

Providing the customer's email skips the intermediate page on which the customer would otherwise be asked to enter an email address.

emailstring<email>

Customer email address used to prefill the payment flow.

Example: test@test.com

shop_idstring

Identifier of the shop originating the payment request.

This field is commonly used by payment service providers acting as a proxy for multiple payment methods.

Example: shop1

PagoEfectivo Payment Request

{
  "type": "PAYSAFECARD",
  "amount": 10,
  "currency": "USD",
  "redirect": {
    "success_url": "https://ok.com",
    "failure_url": "https://nok.com",
    "auth_url": "https://customer.test.at.paysafecard.com/psccustomer/GetCustomerPanelServlet"
  },
  "notification_url": "https://notification.com/{payment_id}",
  "customer": {
    "id": "test_dev"
  },
  "restrictions": {
    "payment_instrument": "pagoefectivo",
    "payment_instrument_subtype": "string"
  },
  "submerchant_id": "1",
  "customer_data_takeover": {
    "email": "test@test.com"
  },
  "shop_id": "shop1"
}