Get the authenticated account.

GET

/v1/me

const url = 'https://api.ridleypay.com/v1/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ridleypay.com/v1/me \
  --header 'Authorization: Bearer <token>'

Returns the Source the API key belongs to, whether the key is a live or test key, and the effective configuration. Use this at integration setup to verify a key works before creating payments.

Authorizations

default

Responses

200

Live key

application/json

object

data

object

string

type

string

attributes

object

name

string

slug

string

mode

string

default_currency

string

rate_limit_per_minute

integer

ip_whitelisting_enabled

boolean

webhook_configured

boolean

links

object

self

string

Example

{
  "data": {
    "id": "1",
    "type": "accounts",
    "attributes": {
      "name": "Acme Store",
      "slug": "acme-store",
      "mode": "live",
      "default_currency": "JMD",
      "rate_limit_per_minute": 60,
      "ip_whitelisting_enabled": false,
      "webhook_configured": true
    },
    "links": {
      "self": "https://api.ridleypay.com/v1/me"
    }
  }
}

401

Invalid or missing key

application/json

object

errors

Array<object>

object

status

string

title

string

detail

string

Example

{
  "errors": [
    {
      "status": "401",
      "title": "Unauthorized",
      "detail": "Invalid or missing API key. Provide a secret key (sk_) as a Bearer token."
    }
  ]
}