Create Payment

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

Creates a payment, either type IN or type OUT.

Body Params

merchantId

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.

amount

number

required

≥ 0

Defaults to 223.05

The payment amount.

expiryMinutes

integer

Defaults to 20

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

currency

string

required

length between 2 and 20

Defaults to EUR

The virtual currency to display to end users. Determines the amount due after conversion.

returnUrl

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://

reference

string

required

length between 6 and 255

Defaults to myUniqueRef333

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

type

string

required

Defaults to IN

Defines whether a payment in or payment out.

payInDetails

object

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

payOutDetails

object

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

complianceDetails

object

Specify compliance details about the payment

Responses

Response body

object

uuid

string

The unique identifier for the merchant payment.

merchantDisplayName

string

The display name for the merchant payment.

merchantId

string

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

dateCreated

int64

The date and time, encoded into UNIX epoch timestamps.

expiryDate

int64

The date and time, encoded into UNIX epoch timestamps

quoteExpiryDate

int64

The date and time, encoded into UNIX epoch timestamps

acceptanceExpiryDate

int64

The date and time, encoded into UNIX epoch timestamps

quoteStatus

string

reference

string

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

type

string

Defaults to IN

Defines whether a payment in or payment out.

IN OUT

subType

string

Defaults to merchantPayIn

The payment sub type

merchantPayIn merchantPayOut merchantRefund

status

string

The payment status.

PENDING PROCESSING CANCELLED COMPLETE UNDERPAID OVERPAID EXPIRED

displayCurrency

object

Contains the type of currency, amount to be paid, and amount received.

currency

string

The currency acronym.

amount

number

The amount to be paid.

actual

number

The actual amount received.

walletCurrency

object

Contains the type of currency, amount to be paid, and amount received.

currency

string

The currency acronym.

amount

number

The amount to be paid.

actual

number

The actual amount received.

paidCurrency

object

Contains the type of currency, amount to be paid, and amount received.

currency

string

The currency acronym.

amount

number

The amount to be paid.

actual

number

The actual amount received.

feeCurrency

object

Contains the type of currency, amount to be paid, and amount received.

currency

string

The currency acronym.

amount

number

The amount to be paid.

actual

number

The actual amount received.

displayRate

object

Contains exchange rate information to convert from base currency to counter currency.

base

string

The base currency acronym.

counter

string

The counter currency acronym.

rate

number

The exchange rate

exchangeRate

object

Contains exchange rate information to convert from base currency to counter currency.

base

string

The base currency acronym.

counter

string

The counter currency acronym.

rate

number

The exchange rate

address

object

Payment address details

address

string

The crypto address to send funds to

tag

string

This is a payment destination tag. This fields isn't null when the paidCurrency currency value is XRP.

protocol

string

The protocol behind a currency, 'ERC20' or 'TRC20'.

uri

string

The destination address URI for QR code

alternatives

array of objects

The list of non-default addresses for other tokens

alternatives

object

protocol

string

address

string

tag

string

uri

string

returnUrl

string

The URL that the customer will be redirected to if they click 'Back to Merchant' button on the payment web page.

redirectUrl

string

The URL to the payment page that you redirect your customers to.

transactions

array of objects

transactions

object

dateCreated

int64

The date and time, encoded into UNIX epoch timestamps.

dateConfirmed

int64

The date and time, encoded into UNIX epoch timestamps.

hash

string

Transaction hash.

amount

number

The payment amount.

risk

object

Has additional fields

networkFeeCurrency

string

The currency acronym.

networkFeeAmount

number

The network fee amount.

sources

array of strings

The list of source addresses, only applicable if payment in.

sources

displayRate

object

Contains exchange rate information to convert from base currency to counter currency.

exchangeRate

object

Contains exchange rate information to convert from base currency to counter currency.

refund

object

The payment this object is a refund of. This should reference the pay in that this refund was created for.

Has additional fields

refunds

array of objects

Refunds that have been requested for this payment. This should reference the refund payout for this pay in.

refunds

object

Language

Credentials

Header

URL


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://api.sandbox.layer1.com/api/v1/pay/summary \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "merchantId": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB",
8
  "amount": 223.05,
9
  "currency": "EUR",
10
  "reference": "myUniqueRef333",
11
  "type": "IN"
12
}
13
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

500Unexpected Error