Account Holders5

API Keys2

Audit Trails2

balances2

Bank Code Lookup1

Bank Simulator5

Bulk Actions4

Claims5

connected-accounts3

Connectivity Syncs2

Counterparties5

Counterparty Accounts8

Credit arrangements6

Custom Fields4

DICT droxy claims1

DICT proxy claims6

DICT proxy keys6

DICT proxy lookup3

Direct Debit Mandates7

Events4

Expected Payments5

External Accounts8

Files5

Incoming Payments7

Inquiries4

Internal Accounts7

Loans8

Message forward2

payee-verification-requests7

Payment Captures5

Payment Orders8

Payment Retry Rules2

Platform Health Check1

Process Payments1

Proxy lookup simulator1

Reconciliations5

Return Requests5

Returns7

transactions3

verification-scheme-participants2

Virtual Accounts6

Incoming Payments

Track incoming payment

Track Swift incoming payments with Swift GPI.

post/incoming_payments/{id}/track

Request

Base URL
https://sandbox.numeral.io/v1
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/numeral/apis/payments/docs/incoming_payments/:id/track/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the incoming payment.

Request body

status'rejected' | 'pending' | 'executed' | 'received' required

Swift GPI tracker status.

status_code'G000' | 'G001' | 'G002' | 'G003' | 'G004'

Swift GPI tracker status details, only mandatory when the status is "pending" or "executed". Includes native GPI codes.

rejection_reason_codestring

4 alphanumerical characters Swift GPI rejection code, only mandatory when the status is “rejected”.

Example request

{
  "status": "executed",
  "status_code": "G001",
  "rejection_reason_code": "AC04"
}

Response

Successfully processed. No content returned.

Changes

No recorded changes to this operation across all 1 revision of this API.