Transactions
Generate Transaction Link
Generate payment link
POST https://api.yoyo.do/api/v2/transactions/generate
Generates a new payment link.
Headers
Content-Type*
string
application/json
x-yoyo-key*
string
API key value
Request Body
amount*
float
The amount to charge
openAmount
boolean
If true there is no need to set the amount parameter. The user will be prompted to enter the payment amount.
payer.name
string
Payer's name.
payer.phone
string
Payer's phone number.
payer.email
string
Payer's email address.
webhook.callbackURL
string
Endpoint URL to send transaction information in a POST request.
description
string
Payment Description
expiresIn
date
Sets an expiration date to the payment link.
usageLimit
number
Sets an usage (stock) limit (Used for Product links).
type
string
Link type (STANDARD, PRODUCT). Defaults to STANDARD
nonExpiring
boolean
Indicates that this payment link can be payed multiple times without expiring.
webhook.redirectURL
string
Website to redirect the user to, after a transaction completion.
webhook.headers
Object
Any headers you want Yoyo to send you back with the transaction payload.
metadata
object
An object of metadata you can use to add extra information to identity or associate this transaction to an entity in your system.
billing.mode
String
Billing Modality (SINGLE, RECURRING). Defaults to single payment. Use "RECURRING" to implement the "subscription type" of flow.
billing.period
String
For recurring payments, the time period to collect each payment (WEEKLY, MONTHLY, YEARLY)
Get Transactions
Get Transactions
GET https://api.yoyo.do/api/v2/transactions
Query Parameters
limit
number
mode
count | find
sort
String
fetch
String
from
String
orderID
String
Query by Order BY
Last updated