Payments

Also known as charges

get
Get payments

https://yomer.com/api/v2/commerce/charges
This endpoint allows you to get free cakes.
Request
Response
Headers
ApiKey
required
string
Your ApiKey
Query Parameters
sortOrder
optional
string
"ASC" or "DESC"
sort
optional
string
Will sort results by field
query
optional
string
Will sort results by name, description or code containing query
limit
optional
string
Page size
page
required
number
Page number
200: OK
Cake successfully retrieved.
{
"content":[
{
"id":15,
"ownerID":3,
"payerID":130,
"code":"1SN9RLJ",
"name":"haha",
"fee":{
"type":"FROM_OWNER",
"percent":0.010000000000000000
},
"meta":{
"your-key":"your-value"
},
"description":"hahah",
"createdAt":1569425874.696902000,
"status":"NEW",
"localAmount":43.000000000000000000,
"localCurrency":"USD",
"pricingType":"FIXED_PRICE",
"timeline":[
{
"currency":"USD",
"amount":43.000000000000000000,
"txHash":null,
"status":"NEW",
"createdAt":1569425874842
}
],
"payments":[
],
"addresses":[
{
"currency":"BTC",
"address":"2Mx1FhXfoefcx5YcVf7toodpqWxLwkQAr8L"
},
{
"currency":"LTC",
"address":"Qb7Bt5vuR1xda9VmRCZkJmeQytcJ8G2cbs"
},
{
"currency":"DASH",
"address":"yN2PxgWtJXeMyLHEStePn5EEAoB38zJUVt"
},
{
"currency":"ETH",
"address":"0x8cbefbfe29cc62bf4ea68cda5289c8c5fe01f08c"
},
{
"currency":"USDT",
"address":"0xade83634abb2108a04a570ea35003f3cf275bea7"
},
{
"currency":"BCH",
"address":"bchtest:qphqjevfwtlnu33h2fk5dug0at8zp76zl5697tlhmz"
}
],
"pricing":[
{
"currency":"BTC",
"amount":0.000119756176424799,
"price":8350.300000000000000000
},
{
"currency":"LTC",
"amount":0.017873100983020554,
"price":55.950000000000000000
},
{
"currency":"DASH",
"amount":0.014005602240896359,
"price":71.400000000000000000
},
{
"currency":"ETH",
"amount":0.005989817310572028,
"price":166.950000000000000000
},
{
"currency":"USDT",
"amount":0.996015936254980080,
"price":1.004000000000000000
},
{
"currency":"BCH",
"amount":0.004466479074545536,
"price":223.890000000000000000
}
],
"image":"https://yomer.com/assets/img/cabinet/avatar-placeholder.svg",
"ownerName":"Yoldi Test",
"checkoutId":9
}
],
"page":0,
"pageSize":10,
"totalPages":1
}

post
Create payment

https://yomer.com/api/v2/commerce/charge
This method will create unassigned payment without "placeholder" checkout.
Request
Response
Headers
ApiKey
required
string
Your ApiKey
Body Parameters
meta
optional
object
Metadata
localCurrency
required
string
ex. "USD"
allowedCurrencies
optional
array
string[] Specified crypto currencies to be accepted as payment method.
feeType
required
string
"FROM_PAYER" or "FROM_OWNER". If payer pays fees, you will receive full price of payment when its paid, otherwise you will receive full price minus fees when payment is finished.
localAmount
optional
string
ex. "0.123"
pricingType
required
string
"NO_PRICE" or "FIXED_PRICE". NO_PRICE is donation, FIXED_PRICE is payment with specified price.
description
optional
string
Payment description
name
required
string
Payment name
200: OK
{
"id":15,
"ownerID":3,
"payerID":130,
"code":"1SN9RLJ",
"name":"haha",
"fee":{
"type":"FROM_OWNER",
"percent":0.010000000000000000
},
"meta":{
"your-key":"your-value"
},
"description":"hahah",
"createdTime":1569425874.696902000,
"status":"NEW",
"localAmount":43.000000000000000000,
"localCurrency":"USD",
"pricingType":"FIXED_PRICE",
"timeline":[
{
"currency":"USD",
"amount":43.000000000000000000,
"txHash":null,
"status":"NEW",
"createdAt":1569425874842
}
],
"payments":[
],
"addresses":[
{
"currency":"BTC",
"address":"2Mx1FhXfoefcx5YcVf7toodpqWxLwkQAr8L"
},
{
"currency":"LTC",
"address":"Qb7Bt5vuR1xda9VmRCZkJmeQytcJ8G2cbs"
},
{
"currency":"DASH",
"address":"yN2PxgWtJXeMyLHEStePn5EEAoB38zJUVt"
},
{
"currency":"ETH",
"address":"0x8cbefbfe29cc62bf4ea68cda5289c8c5fe01f08c"
},
{
"currency":"USDT",
"address":"0xade83634abb2108a04a570ea35003f3cf275bea7"
},
{
"currency":"BCH",
"address":"bchtest:qphqjevfwtlnu33h2fk5dug0at8zp76zl5697tlhmz"
}
],
"pricing":[
{
"currency":"BTC",
"amount":0.000119756176424799,
"price":8350.300000000000000000
},
{
"currency":"LTC",
"amount":0.017873100983020554,
"price":55.950000000000000000
},
{
"currency":"DASH",
"amount":0.014005602240896359,
"price":71.400000000000000000
},
{
"currency":"ETH",
"amount":0.005989817310572028,
"price":166.950000000000000000
},
{
"currency":"USDT",
"amount":0.996015936254980080,
"price":1.004000000000000000
},
{
"currency":"BCH",
"amount":0.004466479074545536,
"price":223.890000000000000000
}
],
"image":"https://yomer.com/assets/img/cabinet/avatar-placeholder.svg",
"ownerName":"Yoldi Test",
"checkoutId":9
}

get
Get payment

https://yomer.com/api/v2/commerce/charge/:code
Returns payment by code. Notice that this method doesn't require token.
Request
Response
Path Parameters
code
required
string
Code of payment
200: OK
{
"id":15,
"ownerID":3,
"payerID":130,
"code":"1SN9RLJ",
"name":"haha",
"fee":{
"type":"FROM_OWNER",
"percent":0.010000000000000000
},
"description":"hahah",
"createdAt":1569425874.696902000,
"status":"NEW",
"localAmount":43.000000000000000000,
"localCurrency":"USD",
"pricingType":"FIXED_PRICE",
"timeline":[
{
"currency":"USD",
"amount":43.000000000000000000,
"txHash":null,
"status":"NEW",
"createdAt":1569425874842
}
],
"payments":[
],
"addresses":[
{
"currency":"BTC",
"address":"2Mx1FhXfoefcx5YcVf7toodpqWxLwkQAr8L"
},
{
"currency":"LTC",
"address":"Qb7Bt5vuR1xda9VmRCZkJmeQytcJ8G2cbs"
},
{
"currency":"DASH",
"address":"yN2PxgWtJXeMyLHEStePn5EEAoB38zJUVt"
},
{
"currency":"ETH",
"address":"0x8cbefbfe29cc62bf4ea68cda5289c8c5fe01f08c"
},
{
"currency":"USDT",
"address":"0xade83634abb2108a04a570ea35003f3cf275bea7"
},
{
"currency":"BCH",
"address":"bchtest:qphqjevfwtlnu33h2fk5dug0at8zp76zl5697tlhmz"
}
],
"pricing":[
{
"currency":"BTC",
"amount":0.000119756176424799,
"price":8350.300000000000000000
},
{
"currency":"LTC",
"amount":0.017873100983020554,
"price":55.950000000000000000
},
{
"currency":"DASH",
"amount":0.014005602240896359,
"price":71.400000000000000000
},
{
"currency":"ETH",
"amount":0.005989817310572028,
"price":166.950000000000000000
},
{
"currency":"USDT",
"amount":0.996015936254980080,
"price":1.004000000000000000
},
{
"currency":"BCH",
"amount":0.004466479074545536,
"price":223.890000000000000000
}
],
"image":"https://yomer.com/assets/img/cabinet/avatar-placeholder.svg",
"ownerName":"Yoldi Test",
"checkoutId":9
}