API Reference

Create Payment

post
https://api.sandbox.layer1.com/api/v1/pay/summary

Creates a payment, either type IN or type OUT.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request data required to create a payment in or a payment out

string
required
length between 6 and 50
Defaults to 5C8D8D78-366A-4AFB-B658-A64CE543C5DB

Your Merchant ID. You can find it on the Merchant Details page in your account.

number
required
≥ 0
Defaults to 223.05

The payment amount.

integer
Defaults to 20

The time period after which payment expires. Overrides the default expiry limit.

string
enum
required
length between 2 and 20
Defaults to EUR

The currency to display to end users. This can be any cryptocurrency code from the supported list or any standard fiat currency code.

string
Defaults to https://my-shop.com/payment-complete?ref=xyz

The URL that the customer will be redirected to if they click 'Back to Merchant' button on the payment web page. Must start with https://

string
required
length between 6 and 255
Defaults to myUniqueRef333

The custom payment reference ID to tie the payment to your customer.

string
enum
required
Defaults to IN

Defines whether a payment is incoming (IN) or outgoing (OUT). IN is for receiving payments from customers, OUT is for sending payments.

Allowed:
payInDetails
object

The payment in details, only needed when "type" is IN.

payOutDetails
object

The payment out details, only needed when "type" is OUT

metadata
object

A key-value map containing metadata. Keys and values have specific length and format restrictions.

Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago

Did this page help you?