Payments
GET
organization_id*stringeventGroupIds?array<string>|Filter by the entry's Order's Event's EventGroup id. Repeat or comma-separate for several.
limit?integerPage size (1-100)
Format
int64Range
1 <= value <= 100Default
20cursor?stringOpaque cursor from meta.nextCursor
includeTotal?booleanSet false to omit meta.total
Default
trueOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uridata*array<>|nullmeta*curl -X GET 'https://example.com/api/v1/organizations/string/ledger'Example Response
{ "$schema": "https://example.com/schemas/PageLedgerEntry.json", "data": [ { "amountMinorUnits": 0, "category": "string", "createdAt": "2019-08-24T14:15:22Z", "creditAccount": "string", "currency": "string", "debitAccount": "string", "id": "string", "orderId": "string", "organizationId": "string" } ], "meta": { "hasMore": true, "limit": 0, "nextCursor": "string", "total": 0 }}GET
organization_id*stringcurrency?stringeventGroupIds?array<string>|Scope the balance to the named EventGroups. Repeat or comma-separate for several.
OK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriavailableMinor*integerFormat
int64currency*stringpayoutableMinor*integerFormat
int64reserveMinor*integerFormat
int64curl -X GET 'https://example.com/api/v1/organizations/string/ledger/balance'Example Response
{ "$schema": "https://example.com/schemas/Balance.json", "availableMinor": 0, "currency": "string", "payoutableMinor": 0, "reserveMinor": 0}GET
organization_id*stringeventGroupIds?array<string>|Filter by the payout's Order's Event's EventGroup id. Repeat or comma-separate for several.
limit?integerPage size (1-100)
Format
int64Range
1 <= value <= 100Default
20cursor?stringOpaque cursor from meta.nextCursor
includeTotal?booleanSet false to omit meta.total
Default
trueOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uridata*array<>|nullmeta*curl -X GET 'https://example.com/api/v1/organizations/string/payouts'Example Response
{ "$schema": "https://example.com/schemas/PagePayout.json", "data": [ { "$schema": "https://example.com/schemas/Payout.json", "amountMinorUnits": 0, "bankReference": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "failureReason": "string", "id": "string", "merchantAccountId": "string", "orderId": "string", "organizationId": "string", "providerOrderId": "string", "providerPaymentId": "string", "providerTransferId": "string", "reserveMinorUnits": 0, "settledAt": "2019-08-24T14:15:22Z", "status": "string" } ], "meta": { "hasMore": true, "limit": 0, "nextCursor": "string", "total": 0 }}GET
organization_id*stringpayout_id*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriamountMinorUnits*integerFormat
int64bankReference?stringcreatedAt*stringFormat
date-timecurrency*stringfailureReason?stringid*stringmerchantAccountId?stringorderId*stringorganizationId*stringproviderOrderId?stringproviderPaymentId?stringproviderTransferId?stringreserveMinorUnits*integerFormat
int64settledAt?stringFormat
date-timestatus*stringcurl -X GET 'https://example.com/api/v1/organizations/string/payouts/string'Example Response
{ "$schema": "https://example.com/schemas/Payout.json", "amountMinorUnits": 0, "bankReference": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "failureReason": "string", "id": "string", "merchantAccountId": "string", "orderId": "string", "organizationId": "string", "providerOrderId": "string", "providerPaymentId": "string", "providerTransferId": "string", "reserveMinorUnits": 0, "settledAt": "2019-08-24T14:15:22Z", "status": "string"}GET
organization_id*stringstatus?stringFilter by refund status
eventGroupIds?array<string>|Filter by the Order's Event's EventGroup id. Repeat or comma-separate for several.
limit?integerPage size (1-100)
Format
int64Range
1 <= value <= 100Default
20cursor?stringOpaque cursor from meta.nextCursor
includeTotal?booleanSet false to omit meta.total
Default
trueOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uridata*array<>|nullmeta*curl -X GET 'https://example.com/api/v1/organizations/string/refunds'Example Response
{ "$schema": "https://example.com/schemas/PageRefund.json", "data": [ { "$schema": "https://example.com/schemas/Refund.json", "amountMinorUnits": 0, "bankReference": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "feeReturnedMinor": 0, "id": "string", "orderId": "string", "organizationId": "string", "providerRefundId": "string", "reason": "string", "sourcePaymentId": "string", "status": "string" } ], "meta": { "hasMore": true, "limit": 0, "nextCursor": "string", "total": 0 }}POST
organization_id*stringapplication/json- body
amountMinorUnits*integerFormat
int64orderId*stringreason?stringregistrationIds?array<string>|nullOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriamountMinorUnits*integerFormat
int64bankReference?stringcreatedAt*stringFormat
date-timecurrency*stringfeeReturnedMinor*integerFormat
int64id*stringorderId*stringorganizationId*stringproviderRefundId?stringreason?stringsourcePaymentId?stringstatus*stringcurl -X POST 'https://example.com/api/v1/organizations/string/refunds' \ -H 'Content-Type: application/json' \ -d '{ "amountMinorUnits": 0, "orderId": "string"}'Example Response
{ "$schema": "https://example.com/schemas/Refund.json", "amountMinorUnits": 0, "bankReference": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "feeReturnedMinor": 0, "id": "string", "orderId": "string", "organizationId": "string", "providerRefundId": "string", "reason": "string", "sourcePaymentId": "string", "status": "string"}GET
organization_id*stringrefund_id*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriamountMinorUnits*integerFormat
int64bankReference?stringcreatedAt*stringFormat
date-timecurrency*stringfeeReturnedMinor*integerFormat
int64id*stringorderId*stringorganizationId*stringproviderRefundId?stringreason?stringsourcePaymentId?stringstatus*stringcurl -X GET 'https://example.com/api/v1/organizations/string/refunds/string'Example Response
{ "$schema": "https://example.com/schemas/Refund.json", "amountMinorUnits": 0, "bankReference": "string", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "feeReturnedMinor": 0, "id": "string", "orderId": "string", "organizationId": "string", "providerRefundId": "string", "reason": "string", "sourcePaymentId": "string", "status": "string"}GET
organization_id*stringcurrency?stringeventGroupIds?array<string>|Scope the statement to the named EventGroups. Repeat or comma-separate for several.
OK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriadjustmentsMinor*integerFormat
int64balanceMinor*integerFormat
int64collectedMinor*integerFormat
int64currency*stringpaidOutMinor*integerFormat
int64refundedMinor*integerFormat
int64curl -X GET 'https://example.com/api/v1/organizations/string/statements'Example Response
{ "$schema": "https://example.com/schemas/LedgerStatement.json", "adjustmentsMinor": 0, "balanceMinor": 0, "collectedMinor": 0, "currency": "string", "paidOutMinor": 0, "refundedMinor": 0}GET
token*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriamountMinorUnits*integerFormat
int64currency*stringdueAt?stringFormat
date-timeeventName?stringorderId*stringpassName?stringproviderReady*booleanreturnUrl?stringstatus*stringcurl -X GET 'https://example.com/api/v1/pay/orders/string'Example Response
{ "$schema": "https://example.com/schemas/PaymentSummary.json", "amountMinorUnits": 0, "currency": "string", "dueAt": "2019-08-24T14:15:22Z", "eventName": "string", "orderId": "string", "passName": "string", "providerReady": true, "returnUrl": "string", "status": "string"}GET
token*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriamountMinorUnits*integerFormat
int64currency*stringdueAt*stringFormat
date-timeeventName?stringorderId*stringpassName?stringpaymentToken?stringproviderOrderId*stringpublishableKey*stringreturnUrl?stringcurl -X GET 'https://example.com/api/v1/pay/orders/string/intent'Example Response
{ "$schema": "https://example.com/schemas/PaymentIntent.json", "amountMinorUnits": 0, "currency": "string", "dueAt": "2019-08-24T14:15:22Z", "eventName": "string", "orderId": "string", "passName": "string", "paymentToken": "string", "providerOrderId": "string", "publishableKey": "string", "returnUrl": "string"}POST
token*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uriconverged*booleanorderId*stringstatus*stringcurl -X POST 'https://example.com/api/v1/pay/orders/string/reconcile'Example Response
{ "$schema": "https://example.com/schemas/ReconcileResult.json", "converged": true, "orderId": "string", "status": "string"}GET
token*stringOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
uricurrency*stringeventId*stringgrandTotalMinorUnits*integerFormat
int64id*stringstatus*stringcurl -X GET 'https://example.com/api/v1/pay/orders/string/status'Example Response
{ "$schema": "https://example.com/schemas/PaidOrder.json", "currency": "string", "eventId": "string", "grandTotalMinorUnits": 0, "id": "string", "status": "string"}POST
provider*stringX-Razorpay-Signature?stringX-Fake-Signature?stringbody*stringapplication/jsonOK
application/json- response
$schema?stringA URL to the JSON Schema for this object.
Format
urireceived*booleancurl -X POST 'https://example.com/api/v1/payments/webhooks/string' \ -H 'Content-Type: application/json' \ -d 'string'Example Response
{ "$schema": "https://example.com/schemas/WebhookOutputBody.json", "received": true}