---
updatedAt: 2025-03-06T23:33:31.000Z
agentTools:
projectIndex: https://developer-gigpay.readme.io/llms.txt
---
# Get payment token (Auth policies: MultipleClientsUserAuthorizationPolicy)
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "GigPay.Core.Host",
"version": "1.0"
},
"paths": {
"/api/v1/payment-tokens/{id}": {
"get": {
"tags": [
"PaymentTokens"
],
"summary": "Get payment token (Auth policies: MultipleClientsUserAuthorizationPolicy)",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Payment token id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Payment token was successfully retrieved",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentTokenResponseModel"
}
}
}
},
"400": {
"description": "Invalid request model",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [
{
"Bearer": [
"MultipleClientsUserAuthorizationPolicy"
]
}
]
}
}
},
"components": {
"schemas": {
"AssetType": {
"enum": [
"usd"
],
"type": "string"
},
"PaymentTokenResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"assetType": {
"$ref": "#/components/schemas/AssetType"
},
"sourceDetails": {
"$ref": "#/components/schemas/SourceDetailsResponseModel"
},
"amount": {
"type": "number",
"format": "double"
},
"expiresAtUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdAtUtc": {
"type": "string",
"format": "date-time"
},
"modifiedAtUtc": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/PaymentTokenStatus"
},
"memo": {
"type": "string",
"nullable": true
},
"transferSource": {
"$ref": "#/components/schemas/TransferStorageResponseModel"
},
"transferDestination": {
"$ref": "#/components/schemas/TransferStorageResponseModel"
}
},
"additionalProperties": false
},
"PaymentTokenStatus": {
"enum": [
"active",
"inProcess",
"succeeded",
"rejected",
"closed",
"expired"
],
"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": {}
},
"SourceDetailsResponseModel": {
"type": "object",
"properties": {
"sourceId": {
"type": "string",
"format": "uuid"
},
"businessName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TransferStorageResponseModel": {
"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
}
},
"additionalProperties": false
}
},
"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
}
}
```