Retrieve refund - Slash

GET

/

payments

/

refund

/

{refundId}

cURL

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

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

fetch('https://api.slash.com/payments/refund/{refundId}', 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/refund/{refundId}"

	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",
  "paymentIntentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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

refundId

string

required

Query Parameters

filter:legalEntityId

string

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

Response

OK

The refund object. Its status tracks the refund from creation through completion.

id

string

required

Unique identifier for the refund.

status

enum<string>

required

Current refund processing status.

Available options:

pending,

processing,

succeeded,

failed

amount

integer

required

Refund amount in the smallest unit of currency. Refunds are always in the currency of the payment intent being refunded.

currency

enum<string>

required

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

Available options:

usd,

eur

paymentIntentId

string

required

The payment intent being refunded.

createdAt

string<date-time>

required

ISO-8601 timestamp the refund was created at.

updatedAt

string<date-time>

required

ISO-8601 timestamp the refund last changed status.

⌘I

cURL

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

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

fetch('https://api.slash.com/payments/refund/{refundId}', 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/refund/{refundId}"

	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",
  "paymentIntentId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "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": {}
}