Create payment intent

POST

payments

payment-intent

cURL

curl --request POST \
  --url https://api.slash.com/payments/payment-intent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 2,
  "metadata": {},
  "allowedPaymentMethods": []
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: 2, metadata: {}, allowedPaymentMethods: []})
};

fetch('https://api.slash.com/payments/payment-intent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/payments/payment-intent"

payload = {
    "amount": 2,
    "metadata": {},
    "allowedPaymentMethods": []
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/payments/payment-intent"

	payload := strings.NewReader("{\n  \"amount\": 2,\n  \"metadata\": {},\n  \"allowedPaymentMethods\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "status": "pending",
  "amount": 123,
  "currency": "usd",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "clientSecret": "<string>",
  "allowedPaymentMethods": [
    "card"
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

Authorizations

X-API-Key

string

header

required

API key authentication for public API requests.

Keys come in two flavors:

Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Headers

X-Idempotency-Key

string

An optional unique key for this payment intent. Retrying the same request with the same key returns the previously created payment intent.

Body

application/json

amount

integer

required

Payment amount in the smallest unit of currency.

Required range: x >= 1

currency

enum<string>

required

ISO currency code for the payment. Supported currencies are usd and eur.

Available options:

usd,

eur

metadata

object

Merchant-defined metadata stored on the payment intent and returned in payment intent responses.

allowedPaymentMethods

enum<string>[]

Payment methods the buyer may use. Omit to allow all supported methods.

Minimum array length: 1

Payment method available for an acquiring PaymentIntent checkout.

Available options:

card,

apple_pay,

google_pay

Response

The payment intent object. Its status tracks the payment from creation through settlement.

string

required

Unique identifier for the payment intent.

status

enum<string>

required

Status of the payment intent. pending intents have not been paid yet; processing intents have a payment in flight awaiting settlement; succeeded intents have a confirmed settled payment; canceled intents were canceled and can no longer be paid.

Available options:

pending,

processing,

succeeded,

canceled

amount

integer

required

Payment amount in the smallest unit of currency.

currency

enum<string>

required

ISO currency code for the payment. Supported currencies are usd and eur.

Available options:

usd,

eur

createdAt

string<date-time>

required

ISO-8601 timestamp the payment intent was created at.

updatedAt

string<date-time>

required

ISO-8601 timestamp the payment intent last changed status.

metadata

object

Merchant-defined metadata stored on the payment intent and echoed in payment intent responses and the payment-intent success webhook.

clientSecret

string

Sensitive PaymentIntent-scoped browser capability. Do not log or store it in browser persistence.

allowedPaymentMethods

enum<string>[]

Payment methods the merchant allows, exactly as set on create or update. Omitted when all supported methods are allowed.

Payment method available for an acquiring PaymentIntent checkout.

Available options:

card,

apple_pay,

google_pay

⌘I

cURL

curl --request POST \
  --url https://api.slash.com/payments/payment-intent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount": 2,
  "metadata": {},
  "allowedPaymentMethods": []
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({amount: 2, metadata: {}, allowedPaymentMethods: []})
};

fetch('https://api.slash.com/payments/payment-intent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/payments/payment-intent"

payload = {
    "amount": 2,
    "metadata": {},
    "allowedPaymentMethods": []
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/payments/payment-intent"

	payload := strings.NewReader("{\n  \"amount\": 2,\n  \"metadata\": {},\n  \"allowedPaymentMethods\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "<string>",
  "status": "pending",
  "amount": 123,
  "currency": "usd",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "clientSecret": "<string>",
  "allowedPaymentMethods": [
    "card"
  ]
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

{
  "message": "<string>",
  "name": "<string>",
  "identifier": "<string>",
  "rawStatus": 123,
  "meta": {}
}

Payment Processing

Entities

Payment Intent

Refund

Create payment intent

Authorizations

Headers

Body

Response