Get a payment

GET

/api/v1/payments/{id}

const url = 'https://digize.com/api/v1/payments/example';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

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://digize.com/api/v1/payments/example \
  --header 'x-api-key: <x-api-key>'

One payment with its card, fee and refunds so far.

Needs the crm:read permission.

Authorizations

apiKey
bearer

Parameters

Path Parameters

required

string

>= 1 characters <= 64 characters

Responses

200

Done

application/json

object

required

string

stripeId

required

The Stripe PaymentIntent, or a subscription charge’s Stripe invoice.

string

source

required

string

Allowed values: order invoice deposit subscription payment_link

description

required

string

contact

required

object

required

The contact’s id.

string

name

required

string

email

required

string

amount

required

In the workspace currency’s minor unit: 2000 is $20.00.

integer

<= 100000000

refunded

required

In the workspace currency’s minor unit: 2000 is $20.00.

integer

<= 100000000

fee

required

Stripe’s fee, once Stripe reported it.

number | null

method

required

Any of:

object
null

object

brand

required

string

last4

required

string

wallet

required

Any of:

string
null

string

Allowed values: apple_pay google_pay

status

required

string

Allowed values: succeeded partially_refunded refunded failed disputed

failure

required

string | null

createdAt

required

string format: date-time

orderId

required

A store order’s payment: refund it with commerce.orders.refund.

string | null

Example

{
  "source": "order",
  "method": {
    "wallet": "apple_pay"
  },
  "status": "succeeded"
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}