Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt

Use this file to discover all available pages before exploring further.

Paysquad is a push payment method. The buyer is sent to a Paysquad hosted page where they complete the payment from their own account, and Paysquad notifies Gr4vy of the outcome via webhook. Buyers are not redirected back to the redirect_url you provided when the transaction was created.

Setup

Paysquad does not provide self-service sign-up. Reach out to Paysquad to set up a sandbox and production account.

Credentials

When setting up Paysquad in the dashboard, configure the following credentials. You can request these details from your Paysquad Merchant Portal once you are set up with an account.
  • API Key - Your secret API key used to authenticate requests to the Paysquad API.
  • Client ID - Your merchant client identifier.
  • Webhook Secret (optional) - A shared secret used to validate the signature of webhooks received from Paysquad. See Webhooks below.

Features

Paysquad supports the following features:
  • Refunds - Full refunds of captured transactions
  • Deep linking - The approval_url can be opened directly in a mobile app
  • Transaction sync - Automatic transaction status synchronization
  • Custom approval expiration - The window during which a buyer can complete the payment can be customized

Supported countries

Paysquad supports transactions from buyers in the following countries:
Country codeCountry codeCountry codeCountry codeCountry codeCountry codeCountry codeCountry code
ADAEAFAGAIALAMAO
AQARASATAUAWAXAZ
BABBBDBEBFBGBHBI
BJBLBMBNBOBQBRBS
BTBVBWBYBZCACCCD
CFCGCHCICKCLCMCN
COCRCUCVCWCXCYCZ
DEDJDKDMDODZECEE
EGEHERESETFIFJFK
FMFOFRGAGBGDGEGF
GGGHGIGLGMGNGPGQ
GRGSGTGUGWGYHKHM
HNHRHTHUIDIEILIM
INIOIQIRISITJEJM
JOJPKEKGKHKIKMKN
KPKRKWKYKZLALBLC
LILKLRLSLTLULVLY
MAMCMDMEMFMGMHMK
MLMMMNMOMPMQMRMS
MTMUMVMWMXMYMZNA
NCNENFNGNINLNONP
NRNUNZOMPAPEPFPG
PHPKPLPMPNPRPSPT
PWPYQARERORSRURW
SASBSCSDSESGSHSI
SJSKSLSMSNSOSRSS
STSVSXSYSZTCTDTF
TGTHTJTKTLTMTNTO
TRTTTVTWTZUAUGUM
USUYUZVAVCVEVGVI
VNVUWFWSXKYEYTZA
ZMZW

Supported currencies

Paysquad supports processing payments in the following currencies:
Currency codeCurrency codeCurrency codeCurrency codeCurrency codeCurrency codeCurrency codeCurrency code
AUDCADCHFDKKEURGBPHKDJPY
MXNNOKNZDSEKSGDUSD

Limitations

The following features are not supported by this connector:
  • Delayed capture - Authorization and capture happen together
  • Partial capture - Capturing a portion of the authorized amount is not supported
  • Partial refunds - Refunding a portion of the captured amount is not supported
  • Void - Canceling a transaction is not supported
  • Payment method tokenization - Storing payment methods for future use is not supported
  • Zero auth - Zero-dollar verification transactions are not supported
  • 3-D Secure - 3-D Secure authentication is not applicable
  • Settlement reporting - Automatic settlement reporting is not supported
Additional push payment limitations:
  • A buyer may never complete the payment, in which case the transaction expires after the approval window
  • Buyers are not returned to the redirect_url after completing the payment, so webhooks are required to detect the final status

Webhooks

Paysquad sends webhook events to notify Gr4vy when a payment succeeds or fails. The webhook endpoint is configured automatically when you set up the connector in the dashboard. To validate the signature of incoming webhooks, set a Webhook Secret value on the connector and configure the same value on the Paysquad side.

Integration

Paysquad is a push payment method. Any Paysquad transaction created returns a transaction resource with a status of processing and a payment_method.approval_url. Display this approval URL to the buyer in a popup, iframe, or by redirecting to it. Once the buyer completes the payment on the Paysquad hosted page, Paysquad sends a webhook to Gr4vy. The transaction status is then updated and your system is notified via a Gr4vy webhook. Start by creating a new transaction with the following required fields.
var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "EUR",
    Country = "NL",
    PaymentMethod =
      TransactionCreatePaymentMethod.CreateCheckoutSessionWithUrlPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "paysquad",
          RedirectUrl = "https://example.com/callback",
        }
      ),
  }
);
After the transaction is created, the API response includes a payment_method.approval_url and the status is set to processing.
{
  "type": "transaction",
  "id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
  "status": "processing",
  "payment_method": {
    "type": "payment-method",
    "approval_url": "https://cdn.gr4vy.com/connectors/..."
  },
  "method": "paysquad"
}
Display the approval_url to the buyer (in a popup, iframe, or redirect) so they can complete the payment on the Paysquad hosted page. Rely on webhooks to detect the final status of the transaction.