---
updatedAt: 2025-03-06T23:33:27.000Z
agentTools:
projectIndex: https://developer-gigpay.readme.io/llms.txt
---
# Get payments (Auth policies: AppUserAuthorizationPolicy)
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "GigPay.Core.Host",
"version": "1.0"
},
"paths": {
"/v1/payments": {
"get": {
"tags": [
"Payments"
],
"summary": "Get payments (Auth policies: AppUserAuthorizationPolicy)",
"responses": {
"200": {
"description": "Payments were successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentResponseAppModelPageResponseModel"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": [
"AppUserAuthorizationPolicy"
]
}
]
}
}
},
"components": {
"schemas": {
"PageMetadata": {
"type": "object",
"properties": {
"pageCount": {
"type": "integer",
"format": "int32"
},
"resourceCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"PaymentAssetType": {
"enum": [
"usd"
],
"type": "string"
},
"PaymentResponseAppModel": {
"type": "object",
"properties": {
"paymentId": {
"type": "string",
"format": "uuid"
},
"amount": {
"type": "number",
"format": "double"
},
"fees": {
"type": "number",
"format": "double",
"nullable": true
},
"assetType": {
"$ref": "#/components/schemas/PaymentAssetType"
},
"status": {
"$ref": "#/components/schemas/PaymentStatusDto"
},
"type": {
"$ref": "#/components/schemas/PaymentType"
},
"withdrawalType": {
"$ref": "#/components/schemas/WithdrawalType"
},
"memo": {
"type": "string",
"nullable": true
},
"createdAtUtc": {
"type": "string",
"format": "date-time"
},
"modifiedAtUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"source": {
"$ref": "#/components/schemas/TransferStorageResponseAppModel"
},
"destination": {
"$ref": "#/components/schemas/TransferStorageResponseAppModel"
},
"paymentTokenId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"PaymentResponseAppModelPageResponseModel": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentResponseAppModel"
},
"description": "Gets or sets the data.",
"nullable": true
},
"meta": {
"$ref": "#/components/schemas/PageMetadata"
}
},
"additionalProperties": false
},
"PaymentStatusDto": {
"enum": [
"processing",
"completed",
"failed",
"canceled"
],
"type": "string"
},
"PaymentType": {
"enum": [
"deposit",
"transfer",
"withdrawal"
],
"type": "string"
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": {}
},
"TransferStorageResponseAppModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"businessAccountId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"userIdentityId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"externalStorage": {
"type": "string",
"nullable": true
},
"payor": {
"type": "string",
"nullable": true
},
"bankRoutingNumber": {
"type": "string",
"nullable": true
},
"bankAccountNumber": {
"type": "string",
"nullable": true
},
"zelleAccountEmail": {
"type": "string",
"nullable": true
},
"zelleAccountPhone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"WithdrawalType": {
"enum": [
"zelle",
"ach",
"wire"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Put access token in the box below.
For example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6I",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": []
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```