Get an inbound credit

curl --request GET \
  --url https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "icr_01JCFSECZP11HYGCPWPQ5E6EYC",
  "object": "inbound_credit",
  "response_code": "00",
  "response_message": "Approved or completed successfully",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:03Z",
  "amount": {
    "amount": 125000000,
    "currency": "NGN"
  },
  "status": "matched",
  "received_at": "2026-10-27T08:41:00Z",
  "payer": {
    "account_number": "0123984471",
    "bank_code": "058",
    "bank_name": "GTBank",
    "account_name": "KANO FREIGHT SERVICES LTD"
  },
  "narration": "INV-0142 haulage",
  "session_id": "000013261027094100123456789012",
  "received_into": {
    "type": "invoice_virtual_account",
    "account_number": "9001424730"
  },
  "matched_to": {
    "type": "invoice",
    "id": "ivc_01JFBF5KZNWJ47TAN9ZT24MNPZ",
    "label": "INV-0142",
    "matched_by": "account_number"
  },
  "credited_account": {
    "id": "acc_01J26W14WMCHWYFGCW8T7SWM4F",
    "name": "Naira · Main",
    "account_number": "8012457739"
  },
  "transaction_id": "txn_01JPM5Q1NXW1RNJ47E65GH2BH8",
  "matched_at": "2026-10-27T08:41:03Z"
}

GET

inbound-credits

{inbound_credit_id}

Get an inbound credit

curl --request GET \
  --url https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/inbound-credits/{inbound_credit_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "id": "icr_01JCFSECZP11HYGCPWPQ5E6EYC",
  "object": "inbound_credit",
  "response_code": "00",
  "response_message": "Approved or completed successfully",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:03Z",
  "amount": {
    "amount": 125000000,
    "currency": "NGN"
  },
  "status": "matched",
  "received_at": "2026-10-27T08:41:00Z",
  "payer": {
    "account_number": "0123984471",
    "bank_code": "058",
    "bank_name": "GTBank",
    "account_name": "KANO FREIGHT SERVICES LTD"
  },
  "narration": "INV-0142 haulage",
  "session_id": "000013261027094100123456789012",
  "received_into": {
    "type": "invoice_virtual_account",
    "account_number": "9001424730"
  },
  "matched_to": {
    "type": "invoice",
    "id": "ivc_01JFBF5KZNWJ47TAN9ZT24MNPZ",
    "label": "INV-0142",
    "matched_by": "account_number"
  },
  "credited_account": {
    "id": "acc_01J26W14WMCHWYFGCW8T7SWM4F",
    "name": "Naira · Main",
    "account_number": "8012457739"
  },
  "transaction_id": "txn_01JPM5Q1NXW1RNJ47E65GH2BH8",
  "matched_at": "2026-10-27T08:41:03Z"
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

inbound_credit_id

string

required

Inbound credit id (icr_…).

Pattern: ^icr_[0-9A-HJKMNP-TV-Z]{26}$

Response

The inbound credit.

Money received (icr_…), recorded once it has been credited to your account. A money-movement object, so it carries ResponseOutcome (CONVENTIONS §7a), which is always 00: matched and unattached are both credited to your account (unattached only lacks an invoice, link or virtual account).

response_code

enum<string>

required

Two-character ISO 8583 response code, using the NIBSS NIP meanings (CONVENTIONS §7a). 00 is success. Carried on every error (mapped from error.code, see errors.yaml x-codes) and on every money-movement object (the bank's final code, or our own while it is in flight). Clients must tolerate codes added later.

Available options:

00,

01,

03,

05,

06,

07,

08,

09,

12,

13,

14,

15,

16,

17,

21,

25,

26,

30,

34,

35,

51,

57,

58,

61,

63,

65,

68,

91,

92,

94,

96,

97

Pattern: ^[0-9A-Z]{2}$

response_message

string

required

Standard meaning of the code (the x-codes text), not customer copy. Customer-safe wording is in status_reason / error.message.

Example:

"Approved or completed successfully"

string

required

icr_…

object

string

required

Always inbound_credit.

Allowed value: "inbound_credit"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

amount

object

required

An amount in minor units (kobo, cents) with its currency. Never a decimal.

Show child attributes

status

enum<string>

required

Every inbound credit a business sees is already credited to one of its accounts.

matched: credited to your account and recorded against an invoice, payment link or static virtual account.
unattached: credited to your account, but not tied to any invoice, link or virtual account (e.g. a transfer to Naira · Main without an invoice number). Attach it with matchInboundCredit.

Available options:

matched,

unattached

received_at

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

received_into

object

required

The account number the payer sent to.

Show child attributes

updated_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

fee

object

Collection fee charged on this credit, if the business's plan has one. Posted separately.

Show child attributes

payer

object

The sending account, from the bank. account_name is the name the bank reported.

Show child attributes

payer_contact

object

Details the payer typed on a pay page checkout, when there was one.

Show child attributes

narration

string

Narration sent with the transfer.

session_id

string

NIP session id.

Pattern: ^\d{30}$

matched_to

object

What the credit was matched to. For unattached credits type is account.

Show child attributes

credited_account

object

One of the business's own PanoFlow accounts (owned by the Accounts service).

Show child attributes

transaction_id

string

Transaction (txn_…) in the account view, once credited.

checkout_id

string

Pay page checkout (cko_…) this credit paid, when there was one.

matched_at

string<date-time>

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Get an inbound credit

Authorizations

Headers

Path Parameters

Response