api
payment-requests

Changed on

Create a Payment Request for Customer Payment Method Setup

post/api/payments/requests/setup

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/payments/requests/setup
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

amountnumber float

The amount to charge

customerIdstring

The ID of the customer to create the payment request for

paymentStrategyIdstring

The ID of the payment strategy to use

paymentOptionIdstring

The ID of the payment option to use

redirectUrlstring uri

Absolute https URL the shop returns the customer to once the payment method has been added. The host must be on the seller's redirectUrlHosts allow-list.

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 new optional request property

    • info

      added the optional property to the response with the status

  • a18eefe17b94Revision changes
    • warning

      added the new paymob enum value to the // response property for the response status