api
payment-requests

Changed on

Confirm a Payment Request

post/api/payments/requests/{id}/confirm

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/payments/requests/{id}/confirm
  • Auth: none declared

Path parameters

idstring required

The ID of the payment request

Request body

gatewaySecretstring required

The secret of the payment gateway responsible for the payment

referencestring

A reference to the payment

paymentStatus'SUCCEEDED' | 'PENDING'

The status of the payment

paymentMethod'visa' | 'mc' | 'sepadirectdebit' | 'amex' | 'sofort' | 'klarna' | 'ideal' | 'giropay' | 'girocard' | 'paypal' | 'local' | 'discover' | 'custom' | 'twint' | 'postfinance' | 'blik' | 'p24' | 'affirm' | 'dankort' | 'eps' | 'mobilepay' | 'payconiq' | 'bancontact' | 'payfast' | 'distributor' | 'marketplace' | 'cartebancaire' | 'paymentplan' | 'bizum' | 'afterpay' | 'zip' | 'ach' | 'paybybank' | 'link' | 'alipay' | 'wechatpay' | 'pix' | 'eftpos' | 'revolutpay' | 'wero' | 'scalapay' | 'vipps' | 'cashapppay' | 'crypto' | 'interac' | 'customerbalance' | 'unionpay' | 'grabpay' | 'unknown' | 'none'

The payment method used to pay

paymentMethodVariant'applepay' | 'googlepay' | 'link'

The payment variant used to pay

Response

OK

_idstring required

The ID of the payment request

secretstring required

The secret token of the payment request

amountnumber float

The amount which needs to be paid

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

An ISO 4217 3-character code of the currency

checkoutIdstring

The ID of the checkout that request belongs to

subscriptionIdstring

The ID of the subscription that request belongs to

paymentPlanIdstring

The ID of the payment plan that request belongs to

paymentGatewayIdstring

The ID of the payment gateway responsible for the payment

referencestring
status'NEW' | 'SUCCEEDED' | 'CANCELED' required
sellerIdstring required
redirectUrlstring

The URL the customer is returned to once the payment method has been added

expiresAtstring date-time

An ISO timestamp indicating when the payment request will expire and a new one will be created if requested

createdAtstring date-time required

An ISO timestamp indicating when the payment request was created

updatedAtstring date-time required

An ISO Timestamp indicating when the payment request was last updated

Changes

  • 269d998e6d11Revision changes
    • info

      added the optional property to the response with the status

  • ff78046ac535Revision changes
    • info

      added the new grabpay enum value to the request property

    • info

      added the new unionpay enum value to the request property