List payments with transactions

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "page": 1,
    "pageSize": 20
  }
}
'

{
  "payments": [
    {
      "id": "pay_123xyz",
      "amount": 2999,
      "currency": "USD",
      "status": "succeeded",
      "createdAt": "2024-03-20T10:30:00Z",
      "customer": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe"
      },
      "paymentInstrument": {
        "card": {
          "last4": "4242",
          "brand": "visa",
          "expYear": 2025,
          "expMonth": 12
        }
      },
      "transactions": [
        {
          "id": "txn_123",
          "type": "purchase",
          "status": "succeeded",
          "amount": 2999,
          "currency": "USD"
        }
      ]
    }
  ],
  "total": 1,
  "pageCount": 1
}

POST

api

public

payments

curl --request POST \
  --url https://app.tagadapay.com/api/public/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "page": 1,
    "pageSize": 20
  }
}
'

{
  "payments": [
    {
      "id": "pay_123xyz",
      "amount": 2999,
      "currency": "USD",
      "status": "succeeded",
      "createdAt": "2024-03-20T10:30:00Z",
      "customer": {
        "email": "[email protected]",
        "firstName": "John",
        "lastName": "Doe"
      },
      "paymentInstrument": {
        "card": {
          "last4": "4242",
          "brand": "visa",
          "expYear": 2025,
          "expMonth": 12
        }
      },
      "transactions": [
        {
          "id": "txn_123",
          "type": "purchase",
          "status": "succeeded",
          "amount": 2999,
          "currency": "USD"
        }
      ]
    }
  ],
  "total": 1,
  "pageCount": 1
}

Authorizations

Authorization

string

header

required

Enter your API key as: Bearer your-api-key

Body

application/json

pagination

object

Show child attributes

pagination.page

number

required

pagination.pageSize

number

required

sortBy

object

Show child attributes

sortBy.field

enum<string>

required

Available options:

id,

accountId,

createdAt,

updatedAt

sortBy.direction

enum<string>

required

Available options:

asc,

desc

filters

object

Show child attributes

filters.storeIds

string[]

filters.initiatedBy

enum<string>

Available options:

customer,

merchant

filters.createdAt

string

filters.amount

filters.status

enum<string>

Available options:

pending,

succeeded,

error,

refunded,

declined,

expired,

rejected

filters.subStatus

enum<string>

Available options:

authorized,

waiting_action,

approved,

declined,

captured,

partially_captured,

partially_refunded,

pending_provider_confirm,

refunded,

canceled,

received,

pending_review,

error,

timeout,

expired,

rejected,

unknown

filters.orderId

string

filters.currency

string[]

filters.isDisputed

boolean

filters.disputeStatus

enum<string>

Available options:

response-needed,

under-review,

forfeited,

won,

lost,

unknown,

refunded,

refunded_externally

filters.disputeType

enum<string>

Available options:

information-request,

first-chargeback,

second-chargeback,

fraud,

ethoca-alert,

verifi-alert,

paypal-claim,

representment,

rdr

filters.disputeReasonCode

enum<string>

Available options:

0,

00,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10.1,

10.2,

10.3,

10.4,

10.5,

11.1,

11.2,

11.3,

12,

12.1,

12.2,

12.3,

12.4,

12.5,

12.6,

12.7,

13.1,

13.2,

13.3,

13.4,

13.5,

13.6,

13.7,

13.8,

13.9,

30,

31,

34,

35,

37,

40,

41,

42,

46,

47,

49,

50,

51,

53,

54,

55,

57,

59,

60,

62,

63,

70,

71,

72,

73,

74,

75,

76,

77,

78,

79,

80,

81,

82,

83,

85,

86,

93,

98,

1000,

2700,

2702,

A,

A01,

A02,

A08,

AL,

AP,

AW,

B,

C02,

C04,

C05,

C08,

C14,

C18,

C28,

C31,

C32,

CA,

CD,

CR,

DA,

DP,

DP1,

EX,

F10,

F14,

F22,

F24,

F29,

FR1,

FR4,

FR6,

IC,

IN,

IS,

LP,

M01,

M10,

M49,

N,

NA,

NC,

P,

P01,

P03,

P04,

P05,

P07,

P08,

P22,

P23,

R03,

R13,

RG,

RM,

RN1,

RN2,

SV,

TF,

TNM,

UA01,

UA02,

UA03,

UA10,

UA11,

UA12,

UA18,

UA20,

UA21,

UA22,

UA23,

UA28,

UA30,

UA31,

UA32,

UA38,

UA99,

bank_cannot_process,

credit_not_processed,

customer_initiated,

debit_not_authorized,

duplicate,

fraudulent,

general,

incorrect_account_details,

insufficient_funds,

pre-chargeback-alert,

product_not_received,

product_unacceptable,

subscription_canceled,

unrecognized

filters.authCode

string

filters.card

object

Show child attributes

filters.card.last4

string

filters.card.brand

string

filters.card.year

number

filters.card.month

number

filters.customer

object

Show child attributes

filters.customer.fullName

string

filters.customer.email

string

filters.date

object

Show child attributes

filters.date.condition

enum<string>

required

Available options:

is-equal-date,

is-between-date,

is-after-date,

is-before-date

filters.date.value

string[]

required

useCursor

boolean

default:false

Enable keyset pagination. IMPORTANT: when using keyset pagination, the payments will be sorted by createdAt in descending order. You cannot change this for now and should not be using sortBy option

cursor

string

Keyset pagination cursor, you can get this from the previous response 'nextCursor' attribute

Response

Successful response

Pay checkout session V2 Refund payment

⌘I

API documentation

API endpoints

Authorizations

Body

Response