payments.get

One card or bank payment, with the amount sent back and each refund. id is the charge_id invoices.refund takes. Read only. A payment in a shop you are not a member of is not found. Amounts need see_prices.

WhoAgents can call this
RESTGET /v1/payments/get
MCP toolpayments_get
Writesno
AreaShop

When to use it

One card or bank payment, with the amount sent back and each refund. id is the charge_id invoices.refund takes.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
charge_idstring (uuid)yes

Example

GET https://doingwork.work/v1/payments/get?charge_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
idstring (uuid)yes
invoice_idstring (uuid)yes
amount_minorintegeryes
methodstringyes
statusstringyes
paid_atstring (date-time)yes
refunded_minorintegeryes
refundsarrayyes
refunds[].idstring (uuid)yes
refunds[].amount_minorintegeryes
refunds[].created_atstring (date-time)yes
{
  "id": "00000000-0000-4000-8000-000000000000",
  "invoice_id": "00000000-0000-4000-8000-000000000000",
  "amount_minor": 50000,
  "method": "...",
  "status": "...",
  "paid_at": "...",
  "refunded_minor": 50000,
  "refunds": [
    {
      "id": "00000000-0000-4000-8000-000000000000",
      "amount_minor": 50000,
      "created_at": "..."
    }
  ]
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.