Retrieve payment intent

GET

payments

payment-intent

{paymentIntentId}

cURL

curl --request GET \
  --url https://api.slash.com/payments/payment-intent/{paymentIntentId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	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.

Path Parameters

paymentIntentId

string

required

Query Parameters

filter:legalEntityId

string

The legal entity ID. Required if authenticating with access to multiple legal entities.

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 GET \
  --url https://api.slash.com/payments/payment-intent/{paymentIntentId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	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

Retrieve payment intent

Authorizations

Path Parameters

Query Parameters

Response