gigstack API

List payments

Develop Env

https://api.gigstack.io/v2

GET

/payments

Payments

Returns a list of payments

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.gigstack.io/v2/payments' \
--header 'Authorization;'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": "string",
            "fid": "string",
            "v": 0,
            "team": "string",
            "owner": "string",
            "billingAccount": "string",
            "amount": 0,
            "currency": "MXN",
            "status": "requires_payment_method",
            "internalStatus": "string",
            "client": {
                "id": "string",
                "billingAccount": "string",
                "metadata": {
                    "internalId": "string",
                    "reference": "string",
                    "stringitems": "string",
                    "property1": "string",
                    "property2": "string"
                },
                "owner": "string",
                "email": "user@example.com",
                "from": "string",
                "team": "string",
                "name": "string",
                "rfc": "string",
                "legal_name": "string",
                "timestamp": 0,
                "livemode": true,
                "tax_system": "string",
                "address": {
                    "street": "string",
                    "city": "string",
                    "state": "string",
                    "zip": "string",
                    "country": "string"
                },
                "phone": "string",
                "use": "string"
            },
            "clientId": "string",
            "items": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "quantity": 0,
                    "total": 0,
                    "unitPrice": 0,
                    "product_key": "string",
                    "unit_key": "string",
                    "unit_name": "string",
                    "taxes": [
                        {
                            "type": "string",
                            "rate": 0,
                            "factor": "Tasa",
                            "base": 0,
                            "amount": 0,
                            "retained": true
                        }
                    ],
                    "discount": 0,
                    "currency": "MXN",
                    "paymentType": {
                        "label": "string",
                        "value": "fixed"
                    },
                    "serviceId": "string",
                    "category": "string",
                    "subcategory": "string"
                }
            ],
            "internalItems": [
                {
                    "id": "string",
                    "name": "string",
                    "description": "string",
                    "quantity": 0,
                    "total": 0,
                    "unitPrice": 0,
                    "product_key": "string",
                    "unit_key": "string",
                    "unit_name": "string",
                    "taxes": [
                        {
                            "type": "string",
                            "rate": 0,
                            "factor": "Tasa",
                            "base": 0,
                            "amount": 0,
                            "retained": true
                        }
                    ],
                    "discount": 0,
                    "currency": "MXN",
                    "paymentType": {
                        "label": "string",
                        "value": "fixed"
                    },
                    "serviceId": "string",
                    "category": "string",
                    "subcategory": "string"
                }
            ],
            "discount": 0,
            "exchange": 0,
            "exchangeRate": 0,
            "exchange_rate": 0,
            "exchangeRateDate": "2019-08-24T14:15:22Z",
            "payment_form": "string",
            "paidId": "string",
            "paidIn": "string",
            "processor": "string",
            "custom_method_types": [
                {
                    "name": "string",
                    "id": "string",
                    "logo": "http://example.com",
                    "details": "string",
                    "manualConfirmation": true,
                    "requiredKey": "string"
                }
            ],
            "automations": [
                {
                    "action": "string",
                    "ref": "string",
                    "type": "string",
                    "from": "string"
                }
            ],
            "invoices": [
                "string"
            ],
            "payments": [
                "string"
            ],
            "relatedTo": "string",
            "recurringEventNumber": 0,
            "skc": true,
            "avoidEmail": true,
            "forceReceipt": true,
            "invoiceConfig": {},
            "conceptReference": "string",
            "binnacle": "string",
            "event": {},
            "user": {
                "uid": "string",
                "email": "string"
            },
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "from": "string",
            "date": 0,
            "timestamp": 0,
            "created": 0,
            "succeededTimestamp": 0,
            "livemode": true,
            "shortURL": "http://example.com",
            "shortUrl": "http://example.com",
            "token": "string",
            "hasStripe": true,
            "paymentIntent": "string",
            "client_secret": "string",
            "stripeGenerated": true,
            "payment_method_options": {
                "card": {
                    "installments": {},
                    "mandate_options": {},
                    "network": "string",
                    "request_three_d_secure": "string"
                },
                "oxxo": {
                    "expires_after_days": 0
                }
            },
            "transfer_data": {
                "destination": "string",
                "split": 0,
                "splitType": {
                    "master": "client",
                    "connect": "client"
                }
            }
        }
    ],
    "message": "string",
    "next": "string",
    "totalResults": 0,
    "hasMore": true
}

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

limit

integer

optional

Number of items to return per page

>= 1

starting_after

string

optional

Cursor for pagination, ID of the item to start after

order_by

string

optional

Field to order results by

order_direction

enum<string>

optional

Direction to order results (asc or desc)

Allowed values:

ascdesc

amount

number

optional

Filter by amount

status

string

optional

Filter by status

clientId

string

optional

Filter by client ID

rfc

string

optional

Filter by client RFC

Responses

🟢200OK

application/json

List of payments

Body

data

array[object (Payment) {53}]

optional

string

required

Unique payment identifier

fid

string

optional

Functional ID

number

optional

Version number

team

string

optional

Team identifier

owner

string

optional

Owner user ID

billingAccount

string

optional

Billing account identifier

amount

number

required

Payment amount in cents

currency

string

optional

Payment currency code

Default:

MXN

status

enum<string>

required

Current payment status

Allowed values:

requires_payment_methodrequires_confirmationrequires_actionprocessingrequires_capturecanceledsucceeded

internalStatus

string

optional

Internal payment status

client

object

Client

optional

Unified client schema used across all API endpoints

clientId

string

optional

Associated client ID

items

array[object (PaymentItem) {16}]

optional

Array of payment items

internalItems

array[object (PaymentItem) {16}]

optional

Processed internal items array

discount

number

optional

Total discount amount

exchange

number

optional

Exchange rate

exchangeRate

number

optional

Exchange rate (alias)

exchange_rate

number

optional

Exchange rate (alternate field)

exchangeRateDate

string <date-time>

optional

Exchange rate date

payment_form

string

optional

Payment form code

paidId

string

optional

Payment method label

paidIn

string

optional

Payment method used

processor

string

optional

Payment processor

custom_method_types

array[object (PaymentMethod) {6}]

optional

Available payment methods

automations

array [object {4}]

optional

Automation configurations

invoices

array[string] | null

optional

Associated invoice IDs

payments

array[string] | null

optional

Related payment IDs

relatedTo

string | null

optional

Related resource ID

recurringEventNumber

number

optional

Recurring event number

skc

boolean

optional

Skip charge flag

avoidEmail

boolean

optional

Whether to avoid sending email notifications

forceReceipt

boolean

optional

Whether to force receipt creation

invoiceConfig

object

optional

Invoice configuration

conceptReference

string

optional

Payment concept reference

binnacle

string

optional

Payment audit log

event

object

optional

Associated event data

user

object

optional

User information

metadata

object

optional

Additional payment metadata

from

string

optional

Payment source

date

number

optional

Payment date timestamp

timestamp

number

required

Payment creation timestamp

created

number

optional

Creation timestamp

succeededTimestamp

number | null

optional

Success timestamp

livemode

boolean

optional

Whether payment is in live mode

shortURL

string <uri>

optional

Shareable payment link

shortUrl

string <uri>

optional

Shareable payment link (alias)

token

string

optional

JWT token for payment access

hasStripe

boolean

optional

Whether Stripe integration is available

paymentIntent

string

optional

Stripe payment intent ID

client_secret

string

optional

Stripe client secret

stripeGenerated

boolean

optional

Whether Stripe payment intent was generated

payment_method_options

object

optional

Stripe payment method options

transfer_data

object

optional

Split billing transfer information

message

string

optional

string | null

optional

totalResults

integer

optional

hasMore

boolean

optional

🟠401Unauthorized

Modified at 2025-06-16 03:36:47

Create a payment

Get payment by ID