payment-service-api
Last updated
Was this helpful?
.svg?alt=media&token=5f4690a3-d3e0-45f8-aa6b-ba353a5f4d02)
.svg?alt=media&token=712cfff9-4c4c-4d6b-ac9a-4ba99c77020b)
Last updated
Was this helpful?
GraphQl endpoints for payment-service!
API Endpoints
customerDescription
🔒 JWT Token
Returns the customer's record. If the user does not have a previously created customer, this endpoint creates it.
Response
Returns a
Example
Query
Response
exchangeRatesDescription
🔓 Public
Returns exchange rates.
Response
Example
Query
Response
listCardsDescription
🔒 JWT Token
Returns a list of PaymentMethods(cards) attached to the customer.
Response
Example
Query
Response
purchaseEventDescription
🔒 JWT Token
Retrieve purchase event by id attached to the user
Response
Arguments
Unique identifier for the purchase event object
Example
Query
Variables
Response
purchaseEventListDescription
🔒 JWT Token
Returns a list of purchase events attached to the user.
Response
Example
Query
Response
sayHelloResponse
Example
Query
Response
createCardDescription
🔒 JWT Token
Saves information about the card in the database and assigns it to the user. If the user did not have a default payment method, it sets it.
Response
Arguments
Use stripe.createPaymentMethod to convert payment information collected by elements into a PaymentMethod. paymentMethodId is an id key from PaymentMethod object.
Example
Query
Variables
Response
createPurchaseEventDescription
🔒 JWT Token
Create purchase event. The invoice item and invoice are created automatically
Response
Arguments
Price of the token in wei.
Quantity of tokens of token type id purchased
Token id from the NFT contract
Address of the NFT contract
Address of the seller of the NFT
Name of the blockchain network on which the transaction occurs
Id generated by the client
The unique identifier of the enterprise that sells the token.
Example
Query
Variables
Response
detachCardDescription
🔒 JWT Token
Detach a PaymentMethod object from a Customer
Response
Arguments
Unique identifier for the card object.
Example
Query
Variables
Response
getOrCreateFeeRateDescription
🔓 Public
get actual payments fee rates
Response
Arguments
Name of the blockchain network on which the transaction occurs
Unique identifier for enterprise
Example
Query
Variables
Response
Description
The Boolean scalar type represents true or false.
Description
Data required to create the card.
Fields
Use stripe.createPaymentMethod to convert payment information collected by elements into a PaymentMethod. paymentMethodId is an id key from PaymentMethod object.
User identifier created by Stripe.
Unique identifier for the Customer.
Example
Description
CustomerDto describes a user's Stripe payment data
Fields
Auto-incrementing identifier.
User identifier created by Stripe.
Card identifier created by Stripe. If it is not null it is the basic payment method. There is no need to add a new card during a new transaction.
email of the customer.
Time at which the object was created.
Time at which the object was last updated.
Example
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
Description
Quote currencies
Fields
High precision price in USD
High precision price in EUR
High precision price in ETH
Example
Description
Exchange rate object
Fields
Date of last price update
Example
Description
Payments fee rates
Fields
Auto-incrementing identifier.
Unique identifier for enterprise
Fee rate charged during stripe payment. max value 100. Percentage value
Time at which the object was created.
Time at which the object was last updated.
Example
Description
Example
Description
Returns a list of cards and their number.
Fields
Contains an array of cards
The number of objects.
Example
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
Values
ropsten
kovan
ownet
mainnet
binance
bnbtest
sepolia
local
test
polygon
goerli
mumbai
ethereum
shibuya
amoy
base
baseSepolia
Example
Fields
Example
Values
TRANSACTION_ON_CHAIN_PENDING
TRANSACTION_ON_CHAIN_IN_PROGRESS
TRANSACTION_ON_CHAIN_FAILED
TRANSACTION_ON_CHAIN_SUCCEED
Example
Description
Basic information about a credit or debit card.
Fields
Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
Two-letter ISO code representing the country of the card.
Two-digit number representing the card’s expiration month.
Four-digit number representing the card’s expiration year.
The last four digits of the card.
Example
Description
Basic information about a credit or debit card.
Fields
Card brand. Can be American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown.
Two-letter ISO code representing the country of the card.
Two-digit number representing the card’s expiration month.
Four-digit number representing the card’s expiration year.
The last four digits of the card.
Use stripe.createPaymentMethod to convert payment information collected by elements into a PaymentMethod. paymentMethodId is an id key from PaymentMethod object.
Example
Description
Purchase event object. Represent a one-time purchase of any item.
Fields
Auto-incrementing identifier.
Id of the item to be added to an invoice
Id of the invoice
The integer amount in cents.
Three-letter ISO currency code, in lowercase.
Transaction status. May be: DRAFT, TRANSACTION_ON_CHAIN_PENDING, TRANSACTION_ON_CHAIN_IN_PROGRESS, TRANSACTION_ON_CHAIN_FAILED, TRANSACTION_ON_CHAIN_SUCCEED, PAYMENT_SUCCESSFUL, PAYMENT_FAILED
Address of the NFT contract
Token id from the NFT contract
Address of the seller of the NFT
Quantity of tokens of token type id purchased
Name of the blockchain network on which the transaction occurs
Transaction on chain status. Statuses: TRANSACTION_ON_CHAIN_PENDING, TRANSACTION_ON_CHAIN_IN_PROGRESS, TRANSACTION_ON_CHAIN_FAILED, TRANSACTION_ON_CHAIN_SUCCEED
NFT token value in cents.
Fee charged during stripe payment in cents
Fee rate charged during stripe payment. max value 100. Percentage value
Id generated by the client
A unique string that is given to every transaction that is verified and added to the blockchain.
Time at which the object was created.
Time at which the object was last updated.
Example
Description
List of purchase events attached to the user.
Fields
The number of objects.
Contains an array of purchase events
Example
Values
DRAFT
PAYMENT_SUCCESSFUL
PAYMENT_FAILED
Example
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
Returns an
Returns a
Returns a
purchaseEventId -
Returns a
Returns a
Returns a
paymentMethodId -
Returns a
amount -
quantity -
tokenId -
collectionContract -
seller -
network -
messageId -
ownerUri -
Returns a
cardId -
Returns a
network -
ownerUri -
paymentMethodId -
stripeCustomerId -
customerId -
cardData -
id -
stripeCustomerId -
defaultPaymentMethodId -
email -
defaultPaymentMethod -
createdAt -
updatedAt -
USD -
EUR -
ETH -
ETH -
MATIC -
USDC -
USDT -
BNB -
WETH -
DAI -
AVAX -
BUSD -
WBTC -
ATOM -
ASTR -
updatedAt -
id -
ownerUri -
stripePurchaseFee -
createdAt -
updatedAt -
The Float scalar type represents signed double-precision fractional values as specified by .
items -
total -
networkName -
brand -
country -
expirationMonth -
expirationYear -
lastFourDigits -
brand -
country -
expirationMonth -
expirationYear -
lastFourDigits -
paymentMethodId -
id -
invoiceItemId -
invoiceId -
amount -
currency -
purchaseEventStatus -
collectionContract -
tokenId -
seller -
quantity -
networkName -
onchainTxEventStatus -
priceInUSDCents -
serviceFeeInUSDCents -
serviceFeePercentage -
messageId -
transactionHash -
createdAt -
updatedAt -
total -
items -