Skip to main content

Payment Methods

getpaid provide support for a number of payment methods to give you the best coverage in your target markets.

  1. Visa and Mastercard Credit and Debit Cards (more schemes coming soon)
  2. Google Wallet (Roadmap)
  3. Apple Pay (Roadmap)
  4. SEPA Direct Debits (Roadmap)
  5. Open banking (Payment Initiation Service) (Roadmap)
  6. iDEAL. (Roadmap)
  7. Sofort (Roadmap)

Card Payment Flows​

  1. Anonymous : Cardholder-initiated, one-off payments where the card details are not stored for future purchases
  2. Cardholder-Initiated Payments : Payments initiated by the customer, credentials are going to be stored to be used for future Merchant-Initiated Payments. It's possible to execute a zero amount authorization to validate and store the card details so they can be used for future Merchant-Initiated Payments. To identify the payment as a Cardholder-Initiated Payment, the cit_mode flag must be set to initial in the request.
POST https://api.sandbox.getpaid.io/payments

Sample request​

curl -X POST \
https://api.sandbox.getpaid.io/payments \
-H 'authorization: Bearer {{your_access_token}}' \
-H 'content-type: application/json' \
-d '{
    "amount_minor": 1000,
    "currency": "EUR",
    "payment_method": {
        "type": "user_selected"
    },
    "reference": "ORD-123456",
    "description": "Your Haircutz appointment at Emma Stone Hair Salon",
    "integration": {
        "type": "hosted"
    },
    "routing": {
        "platform": {
            "amount_minor": 100,
            "processing_fee_contribution": 20
        },
        "merchants": [
            {
                "type": "seller",
                "id": "acc_4t2942vvcaj9h41mcpaqwss7dp",
                "amount_minor": 900,
                "processing_fee_contribution": 80
            }
        ]
    },
    "urls": {
        "redirect": "https://haircutz.co/checkout/complete?order_id=ORD-123456",
        "webhook": "https://webhooks.haircutz.co/getpaid"
    },
    "cit_mode": "initial"
}'

Sample response​

{
    "id": "pay_4fyeqdchy8vka1m6407t74kfdw",
    "status": "initiated",
    "reference": "ORD-123456",
    "expires_at": "2023-01-31T11:26:35.2349671Z",
    "_links": {
        "curies": [
            {
                "name": "gp",
                "href": "https://api.getpaid.io/rels/{rel}",
                "templated": true
            }
        ],
        "gp:redirect": {
            "href": "https://hpp.sandbox.getpaid.io/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
            "methods": [
                "GET"
            ]
        },
        "self": {
            "href": "https://api.sandbox.getpaid.io/payments/pay_4fyeqdchy8vka1m6407t74kfdw",
            "methods": [
                "GET"
            ]
        }
    }
}
  1. Merchant-Initiated Payments : Payment initiated by the merchant on behalf of the customer, using previously stored card details. MIT payments require an agreement between the merchant and the cardholder and typically require an initial authorization using Strong Customer Authentication (e.g. 3D-Secure). Reference to previous Cardholder-Initiated payment where card details were stored is needed.

Coming soon (in roadmap):

  • Instalments
  • Prepayments
  • Delayed Charges
POST https://api.sandbox.getpaid.io/payments/authorize

Sample request​

curl -X POST \
https://api.sandbox.getpaid.io/payments/authorize \
-H 'authorization: Bearer {{your_access_token}}' \
-H 'content-type: application/json' \
-d '{
    "initial_payment_id": "pay_473cr1y0ghbyc3m1yfbwvn3nxx",
    "amount_minor": 1000,
    "currency": "EUR",
    "reference": "ORD-123456",
    "description": "Your Haircutz appointment at Emma Stone Hair Salon",
    "routing": {
        "platform": {
            "amount_minor": 100,
            "processing_fee_contribution": 50
        },
        "merchants": [
            {
                "type": "seller",
                "id": "acc_4t2942vvcaj9h41mcpaqwss7dp",
                "reference": "ORD-123456",
                "amount_minor": 900,
                "processing_fee_contribution": 50
            }
        ]
    },
    "urls": {
        "webhook": "https://webhooks.haircutz.co/getpaid"
    }
}'

Sample response​

{
    "id": "pay_473cr1y0ghbyc3m1yfbwvn3nxx",
    "status": "captured",
    "succeeded": true,
    "reference": "ORD-123456",
    "_links": {
        "self": {
            "href": "https://api.getpaid.io/payments/pay_473cr1y0ghbyc3m1yfbwvn3nxx"
        }
    }
}

SEPA Direct Debits Flows​

In order to perform a SEPA Direct Debit (or SDD) payment a Mandate needs to be created.

When a buyer selects SDD as payment method, the buyer needs to provide a valid IBAN and a valid email address, then, we will validate that the buyer has access to the provided bank account using an authorized "open banking" provider.

If this process is successful, the buyer would be redirected to a mandate creation form. On the mandate creation, we will ask the buyer to provide some information about the account holder. This information is required by the scheme to validate the mandate. We are currently supporting businesses and consumers as buyer.

info

Once a SDD mandate is created, it would be reused to perform more SDD payments if the provided email and IBAN were registered in a previous active mandate.

If the IBAN remains the same but the email is different, the buyer would need to accept a new mandate, but it would not be required to insert all the mandate information again.

At any case, the bank account validation process will be always required.

Summary of statuses​

First time, before issuing a mandate:

  • Authenticated - user has completed bank account validation
  • Authentication failed - user has failed bank account validation
  • Mandate issued - mandate has been completed and issued successfully

Once mandate has already been issued:

  • Collection initiated - payment request succeeded
  • Collection not completed - payment request failed
  • Payment Settled - payment success
  • Payment declined - payment error