Payments API

Payments API Reference

Start payment flows and get payment URLs to redirect users to Waffy's secure payment interface. Supports multiple payment methods as configured per organization.

Overview

The Payments API allows you to initiate payment flows by generating secure payment URLs. Users are redirected to Waffy's payment interface where they can complete payments using the payment methods configured for your organization.

Multiple Methods

Cards, bank transfers, virtual IBANs, and digital wallets

PCI Compliant

Full PCI DSS compliance and end-to-end encryption

Real-time

Instant payment confirmations and status updates through webhooks

Recommended: Use Payment SDK

For better integration experience and additional features, we recommend using our Payment SDK instead of the direct API calls.

View SDK Documentation

GETStart Payment

Generate a payment URL to redirect users to Waffy's payment interface

Endpoint

GET /api/external/contracts/startPayment/%milestone_contract_id%/%merchant_client_id%

Query Parameters

Parameter	Type	Required	Description
redirectUrl	string	false	URL to redirect user after payment completion
paymentType	string	false	Type of payment (AUTHORIZE_CAPTURE or PURCHASE)

Example Request

GET /api/external/contracts/startPayment/%milestone_contract_id%/%merchant_client_id%?redirectUrl=https://example.com/success&paymentType=PURCHASE

Response (200 OK)

{
  "status": 200,
  "timestamp": "2026-01-20T18:32:12.563788",
  "data": "https://app.waffyapp.com/external/domainId?client_id=%merchant_client_id%&redirect_url=https://example.com/success&paymentType=PURCHASE&payment_methods=MANUAL_BANK_TRANSFER,MOYASAR,TABBY,APPLE_PAY"
}

Common Errors

404 Not Found - Contract Not Found

{
  "status": 404,
  "timestamp": "2026-01-20T18:52:22.831103",
  "error": {
    "status": "NOT_FOUND",
    "message": "Contract was not found for parameters {id={{milestone_contract_id}}}"
  }
}

400 Bad Request - Payment Not Allowed

{
  "status": 400,
  "timestamp": "2026-01-20T18:53:53.015276",
  "error": {
    "status": "BAD_REQUEST",
    "message": "Payment not allowed on contract with id {{milestone_contract_id}} because it is in an un-payable status RESOLVED_REFUND_CUSTOMER.."
  }
}

Payment Flow

How to integrate the payment URL into your application

Call Start Payment API

Make a GET request with contract ID and required parameters

Redirect User

Redirect the user to the returned payment_url

User Completes Payment

User selects payment method and completes payment on Waffy's secure interface

User Redirected Back

After payment completion, user is redirected to your specified redirectUrl

Payment Statuses

Understanding the payment lifecycle

pending

Payment has been created but not yet processed

processing

Payment is being processed by the payment provider

completed

Payment has been successfully processed and funds transferred

failed

Payment failed due to insufficient funds, declined card, or other error

Supported Countries & Currencies

Card Payments

• Global coverage (190+ countries)

• Major card networks: Visa, Mastercard, Amex

• 50+ currencies supported

• 3D Secure authentication

Bank Transfers

• SEPA transfers (EU)

• UK Faster Payments

• US ACH transfers

• SWIFT international transfers

Payment Integration Guide

Learn how to integrate payments into your application

View Guide

Test Cards & Scenarios

Use test card numbers for development and testing

View Test Data